Chilkat Online Tools

Mono / Core Services API / GetVcn

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.SetRequestHeader("Authorization","{{signature}}");
http.SetRequestHeader("Date","{{date}}");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/vcns/:vcnId",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "id magna consectetur",
//   "compartmentId": "proident ullamco et non",
//   "cidrBlock": "ut amet la",
//   "lifecycleState": "TERMINATING",
//   "cidrBlocks": [
//     "et",
//     "amet"
//   ],
//   "defaultDhcpOptionsId": "qui officia reprehenderit Ut",
//   "defaultRouteTableId": "nulla incididunt exercitation fugiat",
//   "defaultSecurityListId": "eiusmod sint aliqua",
//   "definedTags": {},
//   "displayName": "in",
//   "dnsLabel": "qui cupida",
//   "freeformTags": {},
//   "ipv6CidrBlock": "aute Excepteur",
//   "ipv6PublicCidrBlock": "dolore ex dolor Lorem adipisicing",
//   "timeCreated": "1985-03-26T20:05:22.459Z",
//   "vcnDomainName": "ex laborum magna"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

string strVal;

string id = jResp.StringOf("id");
string compartmentId = jResp.StringOf("compartmentId");
string cidrBlock = jResp.StringOf("cidrBlock");
string lifecycleState = jResp.StringOf("lifecycleState");
string defaultDhcpOptionsId = jResp.StringOf("defaultDhcpOptionsId");
string defaultRouteTableId = jResp.StringOf("defaultRouteTableId");
string defaultSecurityListId = jResp.StringOf("defaultSecurityListId");
string displayName = jResp.StringOf("displayName");
string dnsLabel = jResp.StringOf("dnsLabel");
string ipv6CidrBlock = jResp.StringOf("ipv6CidrBlock");
string ipv6PublicCidrBlock = jResp.StringOf("ipv6PublicCidrBlock");
string timeCreated = jResp.StringOf("timeCreated");
string vcnDomainName = jResp.StringOf("vcnDomainName");
int i = 0;
int count_i = jResp.SizeOfArray("cidrBlocks");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("cidrBlocks[i]");
    i = i + 1;
}

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/vcns/:vcnId

Postman Collection Item JSON

{
  "name": "GetVcn",
  "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}}/vcns/:vcnId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "vcns",
        ":vcnId"
      ],
      "variable": [
        {
          "key": "vcnId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
        }
      ]
    },
    "description": "Gets the specified VCN's information."
  },
  "response": [
    {
      "name": "The VCN was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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 \"id\": \"id magna consectetur\",\n \"compartmentId\": \"proident ullamco et non\",\n \"cidrBlock\": \"ut amet la\",\n \"lifecycleState\": \"TERMINATING\",\n \"cidrBlocks\": [\n  \"et\",\n  \"amet\"\n ],\n \"defaultDhcpOptionsId\": \"qui officia reprehenderit Ut\",\n \"defaultRouteTableId\": \"nulla incididunt exercitation fugiat\",\n \"defaultSecurityListId\": \"eiusmod sint aliqua\",\n \"definedTags\": {},\n \"displayName\": \"in\",\n \"dnsLabel\": \"qui cupida\",\n \"freeformTags\": {},\n \"ipv6CidrBlock\": \"aute Excepteur\",\n \"ipv6PublicCidrBlock\": \"dolore ex dolor Lorem adipisicing\",\n \"timeCreated\": \"1985-03-26T20:05:22.459Z\",\n \"vcnDomainName\": \"ex laborum magna\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}