Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('compartmentId','{{compartment_ocid}}');
$queryParams->UpdateString('volumeGroupId','officia sed');
$queryParams->UpdateInt('limit',801);
$queryParams->UpdateString('sortBy','TIMECREATED');
$queryParams->UpdateString('sortOrder','DESC');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonArray')
$jarrResp = new COM("Chilkat.JsonArray");
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "volumeBackupIds": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "expirationTime": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInGBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInMBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sourceType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sourceVolumeGroupBackupId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeRequestReceived": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "uniqueSizeInGbs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "uniqueSizeInMbs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "volumeGroupId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "volumeBackupIds": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "expirationTime": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInGBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInMBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sourceType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sourceVolumeGroupBackupId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeRequestReceived": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "uniqueSizeInGbs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "uniqueSizeInMbs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "volumeGroupId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$i = 0;
$count_i = $jarrResp->Size;
while ($i < $count_i) {
// json is a Chilkat.JsonObject
$json = $jarrResp->ObjectAt($i);
$Value = $json->stringOf('id.value');
$volumeBackupIdsValue = $json->stringOf('volumeBackupIds.value');
$displayNameValue = $json->stringOf('displayName.value');
$compartmentIdValue = $json->stringOf('compartmentId.value');
$timeCreatedValue = $json->stringOf('timeCreated.value');
$typeValue = $json->stringOf('type.value');
$lifecycleStateValue = $json->stringOf('lifecycleState.value');
$definedTagsValue = $json->stringOf('definedTags.value');
$expirationTimeValue = $json->stringOf('expirationTime.value');
$freeformTagsValue = $json->stringOf('freeformTags.value');
$sizeInGBsValue = $json->stringOf('sizeInGBs.value');
$sizeInMBsValue = $json->stringOf('sizeInMBs.value');
$sourceTypeValue = $json->stringOf('sourceType.value');
$sourceVolumeGroupBackupIdValue = $json->stringOf('sourceVolumeGroupBackupId.value');
$timeRequestReceivedValue = $json->stringOf('timeRequestReceived.value');
$uniqueSizeInGbsValue = $json->stringOf('uniqueSizeInGbs.value');
$uniqueSizeInMbsValue = $json->stringOf('uniqueSizeInMbs.value');
$volumeGroupIdValue = $json->stringOf('volumeGroupId.value');
$i = $i + 1;
}
?>
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "volumeGroupId=officia%20sed"
-d "limit=801"
-d "sortBy=TIMECREATED"
-d "sortOrder=DESC"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups
Postman Collection Item JSON
{
"name": "ListVolumeGroupBackups",
"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?compartmentId={{compartment_ocid}}&volumeGroupId=officia sed&limit=801&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "volumeGroupId",
"value": "officia sed",
"description": "The OCID of the volume group."
},
{
"key": "limit",
"value": "801",
"description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
},
{
"key": "page",
"value": "laboris proident officia tempor",
"description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
"disabled": true
},
{
"key": "displayName",
"value": "amet ut",
"description": "A filter to return only resources that match the given display name exactly.\n",
"disabled": true
},
{
"key": "sortBy",
"value": "TIMECREATED",
"description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
}
]
},
"description": "Lists the volume group backups in the specified compartment. You can filter the results by volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups?compartmentId=amet ut&volumeGroupId=officia sed&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "volumeGroupId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-next-page",
"value": "officia sed",
"description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"volumeBackupIds\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"definedTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"expirationTime\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInMBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceVolumeGroupBackupId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeRequestReceived\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"uniqueSizeInGbs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"uniqueSizeInMbs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"volumeGroupId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"volumeBackupIds\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"definedTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"expirationTime\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInMBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceVolumeGroupBackupId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeRequestReceived\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"uniqueSizeInGbs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"uniqueSizeInMbs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"volumeGroupId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups?compartmentId=amet ut&volumeGroupId=officia sed&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "volumeGroupId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
]
}
},
"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?compartmentId=amet ut&volumeGroupId=officia sed&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "volumeGroupId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
]
}
},
"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?compartmentId=amet ut&volumeGroupId=officia sed&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "volumeGroupId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
]
}
},
"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?compartmentId=amet ut&volumeGroupId=officia sed&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "volumeGroupId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
]
}
},
"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?compartmentId=amet ut&volumeGroupId=officia sed&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "volumeGroupId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
]
}
},
"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}"
}
]
}
