Chilkat Online Tools

C / Core Services API / CreateVolumeBackupCopy

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *id;
    const char *v_type;
    const char *displayName;
    const char *compartmentId;
    const char *timeCreated;
    const char *lifecycleState;
    const char *expirationTime;
    const char *kmsKeyId;
    int sizeInGBs;
    int sizeInMBs;
    const char *sourceType;
    const char *sourceVolumeBackupId;
    const char *timeRequestReceived;
    int uniqueSizeInGBs;
    int uniqueSizeInMbs;
    const char *volumeId;

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

    http = CkHttp_Create();

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

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

    // {
    //   "destinationRegion": "aliqua sunt Ut exercitation sit",
    //   "displayName": "velit",
    //   "kmsKeyId": "proident magna"
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"destinationRegion","aliqua sunt Ut exercitation sit");
    CkJsonObject_UpdateString(json,"displayName","velit");
    CkJsonObject_UpdateString(json,"kmsKeyId","proident magna");

    CkHttp_SetRequestHeader(http,"opc-retry-token","aliqua enim i");
    CkHttp_SetRequestHeader(http,"opc-request-id","8wF");
    CkHttp_SetRequestHeader(http,"Content-Type","application/json");
    CkHttp_SetRequestHeader(http,"x-content-sha256","{{content_sha256}}");
    CkHttp_SetRequestHeader(http,"Authorization","{{signature}}");
    CkHttp_SetRequestHeader(http,"Date","{{date}}");

    resp = CkHttp_PostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId/actions/copy","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    id = CkJsonObject_stringOf(jResp,"id");
    v_type = CkJsonObject_stringOf(jResp,"type");
    displayName = CkJsonObject_stringOf(jResp,"displayName");
    compartmentId = CkJsonObject_stringOf(jResp,"compartmentId");
    timeCreated = CkJsonObject_stringOf(jResp,"timeCreated");
    lifecycleState = CkJsonObject_stringOf(jResp,"lifecycleState");
    expirationTime = CkJsonObject_stringOf(jResp,"expirationTime");
    kmsKeyId = CkJsonObject_stringOf(jResp,"kmsKeyId");
    sizeInGBs = CkJsonObject_IntOf(jResp,"sizeInGBs");
    sizeInMBs = CkJsonObject_IntOf(jResp,"sizeInMBs");
    sourceType = CkJsonObject_stringOf(jResp,"sourceType");
    sourceVolumeBackupId = CkJsonObject_stringOf(jResp,"sourceVolumeBackupId");
    timeRequestReceived = CkJsonObject_stringOf(jResp,"timeRequestReceived");
    uniqueSizeInGBs = CkJsonObject_IntOf(jResp,"uniqueSizeInGBs");
    uniqueSizeInMbs = CkJsonObject_IntOf(jResp,"uniqueSizeInMbs");
    volumeId = CkJsonObject_stringOf(jResp,"volumeId");


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "opc-request-id: 8wF"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "destinationRegion": "aliqua sunt Ut exercitation sit",
    "displayName": "velit",
    "kmsKeyId": "proident magna"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId/actions/copy

Postman Collection Item JSON

{
  "name": "CreateVolumeBackupCopy",
  "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"
      },
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeBackups",
        ":volumeBackupId",
        "actions",
        "copy"
      ],
      "variable": [
        {
          "key": "volumeBackupId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume backup."
        }
      ]
    },
    "description": "Creates a volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n"
  },
  "response": [
    {
      "name": "The volume backup copy is being created in specified region.",
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "content-location",
          "value": "officia sed",
          "description": "Location of the resource.\n"
        },
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "location",
          "value": "officia sed",
          "description": "Location of the resource.\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": "opc-work-request-id",
          "value": "officia sed",
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest)\nwith this ID to track the status of the request.\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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}