lianja / Core Services API / ListIPSecConnectionTunnels
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateInt("limit",801)
loQueryParams.UpdateString("page","laboris proident officia tempor")
loHttp.SetRequestHeader("Authorization","{{signature}}")
loHttp.SetRequestHeader("Date","{{date}}")
loResp = loHttp.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJarrResp = createobject("CkJsonArray")
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = .F.
? "Response Body:"
? loJarrResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJarrResp
return
endif
release loResp
// 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>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "bgpSessionInfo": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "cpeIp": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "encryptionDomainConfig": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "routing": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "status": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeStatusUpdated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vpnIp": {
// "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>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "bgpSessionInfo": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "cpeIp": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "encryptionDomainConfig": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "routing": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "status": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeStatusUpdated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vpnIp": {
// "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
lnCount_i = loJarrResp.Size
do while i < lnCount_i
loJson = loJarrResp.ObjectAt(i)
lcValue = loJson.StringOf("compartmentId.value")
lcIdValue = loJson.StringOf("id.value")
lcLifecycleStateValue = loJson.StringOf("lifecycleState.value")
lcBgpSessionInfoValue = loJson.StringOf("bgpSessionInfo.value")
lcCpeIpValue = loJson.StringOf("cpeIp.value")
lcDisplayNameValue = loJson.StringOf("displayName.value")
lcEncryptionDomainConfigValue = loJson.StringOf("encryptionDomainConfig.value")
lcRoutingValue = loJson.StringOf("routing.value")
lcStatusValue = loJson.StringOf("status.value")
lcTimeCreatedValue = loJson.StringOf("timeCreated.value")
lcTimeStatusUpdatedValue = loJson.StringOf("timeStatusUpdated.value")
lcVpnIpValue = loJson.StringOf("vpnIp.value")
release loJson
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJarrResp
Curl Command
curl -G -d "limit=801"
-d "page=laboris%20proident%20officia%20tempor"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels
Postman Collection Item JSON
{
"name": "ListIPSecConnectionTunnels",
"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/:ipscId/tunnels?limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels"
],
"query": [
{
"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"
}
],
"variable": [
{
"key": "ipscId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
}
]
},
"description": "Lists the tunnel information for the specified IPSec connection.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId/tunnels?limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"bgpSessionInfo\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeIp\": {\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 \"encryptionDomainConfig\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"routing\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"status\": {\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 \"timeStatusUpdated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vpnIp\": {\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 \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"bgpSessionInfo\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"cpeIp\": {\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 \"encryptionDomainConfig\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"routing\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"status\": {\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 \"timeStatusUpdated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vpnIp\": {\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/:ipscId/tunnels?limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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/:ipscId/tunnels?limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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/:ipscId/tunnels?limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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/:ipscId/tunnels?limit=801&page=laboris proident officia tempor",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
}
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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}"
}
]
}