Chilkat Online Tools

C# / Core Services API / GetVolumeGroupBackup

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/volumeGroupBackups/:volumeGroupBackupId",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": "amet dolore ullamco",
//   "volumeBackupIds": [
//     "Lorem laborum sunt",
//     "fugiat cillum sunt"
//   ],
//   "displayName": "ex magna",
//   "compartmentId": "dolore laboris",
//   "timeCreated": "1980-12-26T20:45:18.630Z",
//   "type": "INCREMENTAL",
//   "lifecycleState": "FAULTY",
//   "definedTags": {},
//   "expirationTime": "1953-04-03T06:01:14.615Z",
//   "freeformTags": {},
//   "sizeInGBs": 85138526,
//   "sizeInMBs": -60294769,
//   "sourceType": "SCHEDULED",
//   "sourceVolumeGroupBackupId": "in exercitation ea non",
//   "timeRequestReceived": "2020-06-22T19:48:13.717Z",
//   "uniqueSizeInGbs": -64913320,
//   "uniqueSizeInMbs": -98004917,
//   "volumeGroupId": "velit non labore"
// }

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

string strVal;

string id = jResp.StringOf("id");
string displayName = jResp.StringOf("displayName");
string compartmentId = jResp.StringOf("compartmentId");
string timeCreated = jResp.StringOf("timeCreated");
string v_type = jResp.StringOf("type");
string lifecycleState = jResp.StringOf("lifecycleState");
string expirationTime = jResp.StringOf("expirationTime");
int sizeInGBs = jResp.IntOf("sizeInGBs");
int sizeInMBs = jResp.IntOf("sizeInMBs");
string sourceType = jResp.StringOf("sourceType");
string sourceVolumeGroupBackupId = jResp.StringOf("sourceVolumeGroupBackupId");
string timeRequestReceived = jResp.StringOf("timeRequestReceived");
int uniqueSizeInGbs = jResp.IntOf("uniqueSizeInGbs");
int uniqueSizeInMbs = jResp.IntOf("uniqueSizeInMbs");
string volumeGroupId = jResp.StringOf("volumeGroupId");
int i = 0;
int count_i = jResp.SizeOfArray("volumeBackupIds");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("volumeBackupIds[i]");
    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetVolumeGroupBackup",
  "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}}/volumeGroupBackups/:volumeGroupBackupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeGroupBackups",
        ":volumeGroupBackupId"
      ],
      "variable": [
        {
          "key": "volumeGroupBackupId",
          "value": "officia sed",
          "description": "(Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
        }
      ]
    },
    "description": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)."
  },
  "response": [
    {
      "name": "The volume group backup was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups",
            ":volumeGroupBackupId"
          ],
          "variable": [
            {
              "key": "volumeGroupBackupId"
            }
          ]
        }
      },
      "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\": \"amet dolore ullamco\",\n \"volumeBackupIds\": [\n  \"Lorem laborum sunt\",\n  \"fugiat cillum sunt\"\n ],\n \"displayName\": \"ex magna\",\n \"compartmentId\": \"dolore laboris\",\n \"timeCreated\": \"1980-12-26T20:45:18.630Z\",\n \"type\": \"INCREMENTAL\",\n \"lifecycleState\": \"FAULTY\",\n \"definedTags\": {},\n \"expirationTime\": \"1953-04-03T06:01:14.615Z\",\n \"freeformTags\": {},\n \"sizeInGBs\": 85138526,\n \"sizeInMBs\": -60294769,\n \"sourceType\": \"SCHEDULED\",\n \"sourceVolumeGroupBackupId\": \"in exercitation ea non\",\n \"timeRequestReceived\": \"2020-06-22T19:48:13.717Z\",\n \"uniqueSizeInGbs\": -64913320,\n \"uniqueSizeInMbs\": -98004917,\n \"volumeGroupId\": \"velit non labore\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups",
            ":volumeGroupBackupId"
          ],
          "variable": [
            {
              "key": "volumeGroupBackupId"
            }
          ]
        }
      },
      "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}}/volumeGroupBackups/:volumeGroupBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups",
            ":volumeGroupBackupId"
          ],
          "variable": [
            {
              "key": "volumeGroupBackupId"
            }
          ]
        }
      },
      "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}}/volumeGroupBackups/:volumeGroupBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups",
            ":volumeGroupBackupId"
          ],
          "variable": [
            {
              "key": "volumeGroupBackupId"
            }
          ]
        }
      },
      "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}}/volumeGroupBackups/:volumeGroupBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups",
            ":volumeGroupBackupId"
          ],
          "variable": [
            {
              "key": "volumeGroupBackupId"
            }
          ]
        }
      },
      "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}}/volumeGroupBackups/:volumeGroupBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups",
            ":volumeGroupBackupId"
          ],
          "variable": [
            {
              "key": "volumeGroupBackupId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}