Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("compartmentId","{{compartment_ocid}}");
$queryParams->UpdateInt("limit",801);
$http->SetRequestHeader("Authorization","{{signature}}");
$http->SetRequestHeader("Date","{{date}}");
# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jarrResp = chilkat::CkJsonArray->new();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jarrResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "compartmentId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "id": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "drgId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "cpeId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "lifecycleState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "staticRoutes": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "cpeLocalIdentifier": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "cpeLocalIdentifierType": {
# "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>"
# },
# "timeCreated": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "compartmentId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "id": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "drgId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "cpeId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "lifecycleState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "staticRoutes": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "cpeLocalIdentifier": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "cpeLocalIdentifierType": {
# "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>"
# },
# "timeCreated": {
# "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 JsonObject
$json = $jarrResp->ObjectAt($i);
$Value = $json->stringOf("compartmentId.value");
$idValue = $json->stringOf("id.value");
$drgIdValue = $json->stringOf("drgId.value");
$cpeIdValue = $json->stringOf("cpeId.value");
$lifecycleStateValue = $json->stringOf("lifecycleState.value");
$staticRoutesValue = $json->stringOf("staticRoutes.value");
$cpeLocalIdentifierValue = $json->stringOf("cpeLocalIdentifier.value");
$cpeLocalIdentifierTypeValue = $json->stringOf("cpeLocalIdentifierType.value");
$definedTagsValue = $json->stringOf("definedTags.value");
$displayNameValue = $json->stringOf("displayName.value");
$freeformTagsValue = $json->stringOf("freeformTags.value");
$timeCreatedValue = $json->stringOf("timeCreated.value");
$i = $i + 1;
}
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections
Postman Collection Item JSON
{
"name": "ListIPSecConnections",
"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}}/ipsecConnections?compartmentId={{compartment_ocid}}&limit=801",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections"
],
"query": [
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "drgId",
"value": "amet ut",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
"disabled": true
},
{
"key": "cpeId",
"value": "amet ut",
"description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE.",
"disabled": true
},
{
"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
}
]
},
"description": "Lists the IPSec connections for the specified compartment. You can filter the\nresults by DRG or CPE.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "drgId",
"value": "amet ut"
},
{
"key": "cpeId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
]
}
},
"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 \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"drgId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeId\": {\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 \"staticRoutes\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeLocalIdentifier\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeLocalIdentifierType\": {\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 \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"drgId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeId\": {\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 \"staticRoutes\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeLocalIdentifier\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeLocalIdentifierType\": {\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 \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "drgId",
"value": "amet ut"
},
{
"key": "cpeId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
]
}
},
"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}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "drgId",
"value": "amet ut"
},
{
"key": "cpeId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
]
}
},
"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}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "drgId",
"value": "amet ut"
},
{
"key": "cpeId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
]
}
},
"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}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "drgId",
"value": "amet ut"
},
{
"key": "cpeId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
]
}
},
"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}"
}
]
}
