Node.js / Core Services API / ListLocalPeeringGateways
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("compartmentId","{{compartment_ocid}}");
queryParams.UpdateInt("limit",801);
queryParams.UpdateString("vcnId","amet ut");
http.SetRequestHeader("Authorization","{{signature}}");
http.SetRequestHeader("Date","{{date}}");
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jarrResp = new chilkat.JsonArray();
jarrResp.LoadSb(sbResponseBody);
jarrResp.EmitCompact = false;
console.log("Response Body:");
console.log(jarrResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
// json: JsonObject
var json;
var Value;
var displayNameValue;
var idValue;
var peerIdValue;
var isCrossTenancyPeeringValue;
var lifecycleStateValue;
var peeringStatusValue;
var timeCreatedValue;
var vcnIdValue;
var definedTagsValue;
var freeformTagsValue;
var peerAdvertisedCidrValue;
var peerAdvertisedCidrDetailsValue;
var peeringStatusDetailsValue;
var routeTableIdValue;
var i = 0;
var count_i = jarrResp.Size;
while (i < count_i) {
json = jarrResp.ObjectAt(i);
Value = json.StringOf("compartmentId.value");
displayNameValue = json.StringOf("displayName.value");
idValue = json.StringOf("id.value");
peerIdValue = json.StringOf("peerId.value");
isCrossTenancyPeeringValue = json.StringOf("isCrossTenancyPeering.value");
lifecycleStateValue = json.StringOf("lifecycleState.value");
peeringStatusValue = json.StringOf("peeringStatus.value");
timeCreatedValue = json.StringOf("timeCreated.value");
vcnIdValue = json.StringOf("vcnId.value");
definedTagsValue = json.StringOf("definedTags.value");
freeformTagsValue = json.StringOf("freeformTags.value");
peerAdvertisedCidrValue = json.StringOf("peerAdvertisedCidr.value");
peerAdvertisedCidrDetailsValue = json.StringOf("peerAdvertisedCidrDetails.value");
peeringStatusDetailsValue = json.StringOf("peeringStatusDetails.value");
routeTableIdValue = json.StringOf("routeTableId.value");
i = i+1;
}
}
chilkatExample();
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}"
}
]
}
