Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$queryParams = new CkJsonObject();
$queryParams->UpdateString('compartmentId','{{compartment_ocid}}');
$queryParams->UpdateInt('limit',801);
$queryParams->UpdateString('sortBy','TIMECREATED');
$queryParams->UpdateString('sortOrder','DESC');
$http->SetRequestHeader('opc-request-id','8wF');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://iaas.{{region}}.oraclecloud.com/20160918/vlans',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jarrResp = new CkJsonArray();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";
$respStatusCode = $resp->get_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>"
// },
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "cidrBlock": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vcnId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "availabilityDomain": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "nsgIds": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "routeTableId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vlanTag": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "cidrBlock": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vcnId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "availabilityDomain": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "nsgIds": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "routeTableId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vlanTag": {
// "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->get_Size();
while ($i < $count_i) {
// json is a CkJsonObject
$json = $jarrResp->ObjectAt($i);
$Value = $json->stringOf('id.value');
$compartmentIdValue = $json->stringOf('compartmentId.value');
$cidrBlockValue = $json->stringOf('cidrBlock.value');
$lifecycleStateValue = $json->stringOf('lifecycleState.value');
$vcnIdValue = $json->stringOf('vcnId.value');
$availabilityDomainValue = $json->stringOf('availabilityDomain.value');
$definedTagsValue = $json->stringOf('definedTags.value');
$displayNameValue = $json->stringOf('displayName.value');
$freeformTagsValue = $json->stringOf('freeformTags.value');
$nsgIdsValue = $json->stringOf('nsgIds.value');
$routeTableIdValue = $json->stringOf('routeTableId.value');
$timeCreatedValue = $json->stringOf('timeCreated.value');
$vlanTagValue = $json->stringOf('vlanTag.value');
$i = $i + 1;
}
?>
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-d "sortBy=TIMECREATED"
-d "sortOrder=DESC"
-H "opc-request-id: 8wF"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/vlans
Postman Collection Item JSON
{
"name": "ListVlans",
"request": {
"method": "GET",
"header": [
{
"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": "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}}/vlans?compartmentId={{compartment_ocid}}&limit=801&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"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": "vcnId",
"value": "amet ut",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
"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"
},
{
"key": "lifecycleState",
"value": "officia sed",
"description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n",
"disabled": true
}
]
},
"description": "Lists the VLANs in the specified VCN and the specified compartment.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/vlans?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"value": "officia sed"
}
]
}
},
"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 \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cidrBlock\": {\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 \"vcnId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"availabilityDomain\": {\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 \"displayName\": {\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 \"nsgIds\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"routeTableId\": {\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 \"vlanTag\": {\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 \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cidrBlock\": {\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 \"vcnId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"availabilityDomain\": {\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 \"displayName\": {\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 \"nsgIds\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"routeTableId\": {\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 \"vlanTag\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/vlans?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"value": "officia sed"
}
]
}
},
"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": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/vlans?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"value": "officia sed"
}
]
}
},
"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": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/vlans?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"value": "officia sed"
}
]
}
},
"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": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/vlans?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"value": "officia sed"
}
]
}
},
"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": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/vlans?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"value": "officia sed"
}
]
}
},
"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}"
}
]
}
