PureBasic / Core Services API / GetLocalPeeringGateway
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways/:localPeeringGatewayId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "compartmentId": "dolore tempor ",
; "displayName": "amet sit",
; "id": "adipisicing nulla esse",
; "peerId": "incididunt dolor commodo ex do",
; "isCrossTenancyPeering": true,
; "lifecycleState": "TERMINATED",
; "peeringStatus": "PEERED",
; "timeCreated": "1961-11-06T04:30:14.685Z",
; "vcnId": "reprehenderit enim in nisi sit",
; "definedTags": {},
; "freeformTags": {},
; "peerAdvertisedCidr": "ex pariatur",
; "peerAdvertisedCidrDetails": [
; "utpariatur d",
; "consequat quis "
; ],
; "peeringStatusDetails": "sunt veniam dolo",
; "routeTableId": "commodo"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
id.s = CkJsonObject::ckStringOf(jResp,"id")
peerId.s = CkJsonObject::ckStringOf(jResp,"peerId")
isCrossTenancyPeering.i = CkJsonObject::ckBoolOf(jResp,"isCrossTenancyPeering")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
peeringStatus.s = CkJsonObject::ckStringOf(jResp,"peeringStatus")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
vcnId.s = CkJsonObject::ckStringOf(jResp,"vcnId")
peerAdvertisedCidr.s = CkJsonObject::ckStringOf(jResp,"peerAdvertisedCidr")
peeringStatusDetails.s = CkJsonObject::ckStringOf(jResp,"peeringStatusDetails")
routeTableId.s = CkJsonObject::ckStringOf(jResp,"routeTableId")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"peerAdvertisedCidrDetails")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"peerAdvertisedCidrDetails[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways/:localPeeringGatewayId
Postman Collection Item JSON
{
"name": "GetLocalPeeringGateway",
"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}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
}
]
},
"description": "Gets the specified local peering gateway's information."
},
"response": [
{
"name": "The local peering gateway was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId"
}
]
}
},
"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 \"compartmentId\": \"dolore tempor \",\n \"displayName\": \"amet sit\",\n \"id\": \"adipisicing nulla esse\",\n \"peerId\": \"incididunt dolor commodo ex do\",\n \"isCrossTenancyPeering\": true,\n \"lifecycleState\": \"TERMINATED\",\n \"peeringStatus\": \"PEERED\",\n \"timeCreated\": \"1961-11-06T04:30:14.685Z\",\n \"vcnId\": \"reprehenderit enim in nisi sit\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"peerAdvertisedCidr\": \"ex pariatur\",\n \"peerAdvertisedCidrDetails\": [\n \"utpariatur d\",\n \"consequat quis \"\n ],\n \"peeringStatusDetails\": \"sunt veniam dolo\",\n \"routeTableId\": \"commodo\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId"
}
]
}
},
"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}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId"
}
]
}
},
"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}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId"
}
]
}
},
"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}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId"
}
]
}
},
"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}}/localPeeringGateways/:localPeeringGatewayId",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways",
":localPeeringGatewayId"
],
"variable": [
{
"key": "localPeeringGatewayId"
}
]
}
},
"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}"
}
]
}
