Chilkat Online Tools

Ruby / Core Services API / CreateVolumeBackup

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "volumeId": "dolore",
#   "definedTags": {},
#   "displayName": "fugiat tempor quis",
#   "freeformTags": {},
#   "type": "INCREMENTAL"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("volumeId","dolore")
json.UpdateNewObject("definedTags")
json.UpdateString("displayName","fugiat tempor quis")
json.UpdateNewObject("freeformTags")
json.UpdateString("type","INCREMENTAL")

http.SetRequestHeader("opc-retry-token","aliqua enim i")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("x-content-sha256","{{content_sha256}}")
http.SetRequestHeader("Authorization","{{signature}}")
http.SetRequestHeader("Date","{{date}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "ea",
#   "type": "FULL",
#   "displayName": "amet elit occaecat laboris",
#   "compartmentId": "eu et sint",
#   "timeCreated": "2007-11-11T04:41:21.719Z",
#   "lifecycleState": "CREATING",
#   "definedTags": {},
#   "expirationTime": "1998-05-31T02:51:40.598Z",
#   "freeformTags": {},
#   "kmsKeyId": "nostrud sint",
#   "sizeInGBs": 11402,
#   "sizeInMBs": 12081259,
#   "sourceType": "MANUAL",
#   "sourceVolumeBackupId": "in magna laboris consectetur",
#   "timeRequestReceived": "1981-12-16T03:31:57.153Z",
#   "uniqueSizeInGBs": 2257,
#   "uniqueSizeInMbs": 13322289,
#   "volumeId": "eu mollit consectetur Excepteur"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

id = jResp.stringOf("id")
v_type = jResp.stringOf("type")
displayName = jResp.stringOf("displayName")
compartmentId = jResp.stringOf("compartmentId")
timeCreated = jResp.stringOf("timeCreated")
lifecycleState = jResp.stringOf("lifecycleState")
expirationTime = jResp.stringOf("expirationTime")
kmsKeyId = jResp.stringOf("kmsKeyId")
sizeInGBs = jResp.IntOf("sizeInGBs")
sizeInMBs = jResp.IntOf("sizeInMBs")
sourceType = jResp.stringOf("sourceType")
sourceVolumeBackupId = jResp.stringOf("sourceVolumeBackupId")
timeRequestReceived = jResp.stringOf("timeRequestReceived")
uniqueSizeInGBs = jResp.IntOf("uniqueSizeInGBs")
uniqueSizeInMbs = jResp.IntOf("uniqueSizeInMbs")
volumeId = jResp.stringOf("volumeId")

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "volumeId": "dolore",
    "definedTags": {},
    "displayName": "fugiat tempor quis",
    "freeformTags": {},
    "type": "INCREMENTAL"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups

Postman Collection Item JSON

{
  "name": "CreateVolumeBackup",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeBackups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeBackups"
      ]
    },
    "description": "Creates a new backup of the specified volume. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n"
  },
  "response": [
    {
      "name": "The volume backup is being created.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"ea\",\n \"type\": \"FULL\",\n \"displayName\": \"amet elit occaecat laboris\",\n \"compartmentId\": \"eu et sint\",\n \"timeCreated\": \"2007-11-11T04:41:21.719Z\",\n \"lifecycleState\": \"CREATING\",\n \"definedTags\": {},\n \"expirationTime\": \"1998-05-31T02:51:40.598Z\",\n \"freeformTags\": {},\n \"kmsKeyId\": \"nostrud sint\",\n \"sizeInGBs\": 11402,\n \"sizeInMBs\": 12081259,\n \"sourceType\": \"MANUAL\",\n \"sourceVolumeBackupId\": \"in magna laboris consectetur\",\n \"timeRequestReceived\": \"1981-12-16T03:31:57.153Z\",\n \"uniqueSizeInGBs\": 2257,\n \"uniqueSizeInMbs\": 13322289,\n \"volumeId\": \"eu mollit consectetur Excepteur\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"volumeId\": \"dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"fugiat tempor quis\",\n    \"freeformTags\": {},\n    \"type\": \"INCREMENTAL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}