Chilkat Online Tools

Swift / Core Services API / CreateBootVolumeBackup

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

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

    // The following JSON is sent in the request body.

    // {
    //   "bootVolumeId": "aute in",
    //   "definedTags": {},
    //   "displayName": "aliquip in magna",
    //   "freeformTags": {},
    //   "type": "FULL"
    // }

    let json = CkoJsonObject()
    json.UpdateString("bootVolumeId", value: "aute in")
    json.UpdateNewObject("definedTags")
    json.UpdateString("displayName", value: "aliquip in magna")
    json.UpdateNewObject("freeformTags")
    json.UpdateString("type", value: "FULL")

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

    var resp: CkoHttpResponse? = http.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "id": "reprehenderit dolore irure elit",
    //   "displayName": "ex culpa",
    //   "compartmentId": "tempor exercitation commodo cillum",
    //   "timeCreated": "1981-07-30T00:01:31.556Z",
    //   "lifecycleState": "TERMINATED",
    //   "bootVolumeId": "dolore culpa sint",
    //   "definedTags": {},
    //   "expirationTime": "1947-05-09T22:23:58.728Z",
    //   "freeformTags": {},
    //   "imageId": "magna ipsum nisi in",
    //   "kmsKeyId": "tempor veniam deserunt",
    //   "sizeInGBs": 8220,
    //   "sourceBootVolumeBackupId": "consequat sit dolore",
    //   "sourceType": "MANUAL",
    //   "timeRequestReceived": "1959-02-03T20:49:53.527Z",
    //   "type": "INCREMENTAL",
    //   "uniqueSizeInGBs": 2985
    // }

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

    var id: String? = jResp.StringOf("id")
    var displayName: String? = jResp.StringOf("displayName")
    var compartmentId: String? = jResp.StringOf("compartmentId")
    var timeCreated: String? = jResp.StringOf("timeCreated")
    var lifecycleState: String? = jResp.StringOf("lifecycleState")
    var bootVolumeId: String? = jResp.StringOf("bootVolumeId")
    var expirationTime: String? = jResp.StringOf("expirationTime")
    var imageId: String? = jResp.StringOf("imageId")
    var kmsKeyId: String? = jResp.StringOf("kmsKeyId")
    var sizeInGBs: Int = jResp.IntOf("sizeInGBs").intValue
    var sourceBootVolumeBackupId: String? = jResp.StringOf("sourceBootVolumeBackupId")
    var sourceType: String? = jResp.StringOf("sourceType")
    var timeRequestReceived: String? = jResp.StringOf("timeRequestReceived")
    var v_type: String? = jResp.StringOf("type")
    var uniqueSizeInGBs: Int = jResp.IntOf("uniqueSizeInGBs").intValue

}

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 '{
    "bootVolumeId": "aute in",
    "definedTags": {},
    "displayName": "aliquip in magna",
    "freeformTags": {},
    "type": "FULL"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups

Postman Collection Item JSON

{
  "name": "CreateBootVolumeBackup",
  "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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/bootVolumeBackups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "bootVolumeBackups"
      ]
    },
    "description": "Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.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 boot 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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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\": \"reprehenderit dolore irure elit\",\n \"displayName\": \"ex culpa\",\n \"compartmentId\": \"tempor exercitation commodo cillum\",\n \"timeCreated\": \"1981-07-30T00:01:31.556Z\",\n \"lifecycleState\": \"TERMINATED\",\n \"bootVolumeId\": \"dolore culpa sint\",\n \"definedTags\": {},\n \"expirationTime\": \"1947-05-09T22:23:58.728Z\",\n \"freeformTags\": {},\n \"imageId\": \"magna ipsum nisi in\",\n \"kmsKeyId\": \"tempor veniam deserunt\",\n \"sizeInGBs\": 8220,\n \"sourceBootVolumeBackupId\": \"consequat sit dolore\",\n \"sourceType\": \"MANUAL\",\n \"timeRequestReceived\": \"1959-02-03T20:49:53.527Z\",\n \"type\": \"INCREMENTAL\",\n \"uniqueSizeInGBs\": 2985\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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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    \"bootVolumeId\": \"aute in\",\n    \"definedTags\": {},\n    \"displayName\": \"aliquip in magna\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups"
          ]
        }
      },
      "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}"
    }
  ]
}