Chilkat Online Tools

C# / Core Services API / GetVolumeBackup

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.SetRequestHeader("Authorization","{{signature}}");
http.SetRequestHeader("Date","{{date}}");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

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

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId

Postman Collection Item JSON

{
  "name": "GetVolumeBackup",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeBackups",
        ":volumeBackupId"
      ],
      "variable": [
        {
          "key": "volumeBackupId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume backup."
        }
      ]
    },
    "description": "Gets information for the specified volume backup."
  },
  "response": [
    {
      "name": "The volume backup was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId"
          ],
          "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId"
          ],
          "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId"
          ],
          "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": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId"
          ],
          "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId"
          ],
          "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}"
    }
  ]
}