PowerBuilder / Core Services API / ListLocalPeeringGateways
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JarrResp
integer li_RespStatusCode
oleobject loo_Json
string ls_Value
string ls_DisplayNameValue
string ls_IdValue
string ls_PeerIdValue
string ls_IsCrossTenancyPeeringValue
string ls_LifecycleStateValue
string ls_PeeringStatusValue
string ls_TimeCreatedValue
string ls_VcnIdValue
string ls_DefinedTagsValue
string ls_FreeformTagsValue
string ls_PeerAdvertisedCidrValue
string ls_PeerAdvertisedCidrDetailsValue
string ls_PeeringStatusDetailsValue
string ls_RouteTableIdValue
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("compartmentId","{{compartment_ocid}}")
loo_QueryParams.UpdateInt("limit",801)
loo_QueryParams.UpdateString("vcnId","amet ut")
loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")
loo_Resp = loo_Http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JarrResp = create oleobject
// Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
li_rc = loo_JarrResp.ConnectToNewObject("Chilkat.JsonArray")
loo_JarrResp.LoadSb(loo_SbResponseBody)
loo_JarrResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JarrResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JarrResp
return
end if
destroy loo_Resp
// 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>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peerId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isCrossTenancyPeering": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peeringStatus": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vcnId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peerAdvertisedCidr": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peerAdvertisedCidrDetails": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peeringStatusDetails": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "routeTableId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peerId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isCrossTenancyPeering": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peeringStatus": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vcnId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peerAdvertisedCidr": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peerAdvertisedCidrDetails": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "peeringStatusDetails": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "routeTableId": {
// "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
li_Count_i = loo_JarrResp.Size
do while i < li_Count_i
loo_Json = loo_JarrResp.ObjectAt(i)
ls_Value = loo_Json.StringOf("compartmentId.value")
ls_DisplayNameValue = loo_Json.StringOf("displayName.value")
ls_IdValue = loo_Json.StringOf("id.value")
ls_PeerIdValue = loo_Json.StringOf("peerId.value")
ls_IsCrossTenancyPeeringValue = loo_Json.StringOf("isCrossTenancyPeering.value")
ls_LifecycleStateValue = loo_Json.StringOf("lifecycleState.value")
ls_PeeringStatusValue = loo_Json.StringOf("peeringStatus.value")
ls_TimeCreatedValue = loo_Json.StringOf("timeCreated.value")
ls_VcnIdValue = loo_Json.StringOf("vcnId.value")
ls_DefinedTagsValue = loo_Json.StringOf("definedTags.value")
ls_FreeformTagsValue = loo_Json.StringOf("freeformTags.value")
ls_PeerAdvertisedCidrValue = loo_Json.StringOf("peerAdvertisedCidr.value")
ls_PeerAdvertisedCidrDetailsValue = loo_Json.StringOf("peerAdvertisedCidrDetails.value")
ls_PeeringStatusDetailsValue = loo_Json.StringOf("peeringStatusDetails.value")
ls_RouteTableIdValue = loo_Json.StringOf("routeTableId.value")
destroy loo_Json
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JarrResp
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-d "vcnId=amet%20ut"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways
Postman Collection Item JSON
{
"name": "ListLocalPeeringGateways",
"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?compartmentId={{compartment_ocid}}&limit=801&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"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": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
}
]
},
"description": "Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/localPeeringGateways?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
}
]
}
},
"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 \"displayName\": {\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 \"peerId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isCrossTenancyPeering\": {\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 \"peeringStatus\": {\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 \"vcnId\": {\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 \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peerAdvertisedCidr\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peerAdvertisedCidrDetails\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peeringStatusDetails\": {\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 },\n {\n \"compartmentId\": {\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 \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peerId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isCrossTenancyPeering\": {\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 \"peeringStatus\": {\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 \"vcnId\": {\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 \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peerAdvertisedCidr\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peerAdvertisedCidrDetails\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"peeringStatusDetails\": {\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 }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/localPeeringGateways?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
}
]
}
},
"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?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
}
]
}
},
"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?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
}
]
}
},
"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?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
}
]
}
},
"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?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&vcnId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"localPeeringGateways"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vcnId",
"value": "amet ut"
}
]
}
},
"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}"
}
]
}
