Chilkat Online Tools

PureBasic / Core Services API / GetVnic

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/vnics/:vnicId",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)

    ; {
    ;   "availabilityDomain": "irure esse ut aute do",
    ;   "compartmentId": "commodo sed",
    ;   "id": "Excepteur",
    ;   "lifecycleState": "TERMINATED",
    ;   "timeCreated": "1956-01-11T19:38:23.750Z",
    ;   "definedTags": {},
    ;   "displayName": "amet id qui ullamco ",
    ;   "freeformTags": {},
    ;   "hostnameLabel": "culpa dolor Ut tempor quis",
    ;   "isPrimary": true,
    ;   "macAddress": "exercitation in",
    ;   "nsgIds": [
    ;     "ut anim",
    ;     "in consectetur ut est"
    ;   ],
    ;   "privateIp": "laboris ullamco",
    ;   "publicIp": "tempor cillum",
    ;   "skipSourceDestCheck": true,
    ;   "subnetId": "amet velit aliquip",
    ;   "vlanId": "nisi ea sed"
    ; }

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

    strVal.s

    availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
    compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
    id.s = CkJsonObject::ckStringOf(jResp,"id")
    lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
    timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
    displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
    hostnameLabel.s = CkJsonObject::ckStringOf(jResp,"hostnameLabel")
    isPrimary.i = CkJsonObject::ckBoolOf(jResp,"isPrimary")
    macAddress.s = CkJsonObject::ckStringOf(jResp,"macAddress")
    privateIp.s = CkJsonObject::ckStringOf(jResp,"privateIp")
    publicIp.s = CkJsonObject::ckStringOf(jResp,"publicIp")
    skipSourceDestCheck.i = CkJsonObject::ckBoolOf(jResp,"skipSourceDestCheck")
    subnetId.s = CkJsonObject::ckStringOf(jResp,"subnetId")
    vlanId.s = CkJsonObject::ckStringOf(jResp,"vlanId")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"nsgIds")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"nsgIds[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/vnics/:vnicId

Postman Collection Item JSON

{
  "name": "GetVnic",
  "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}}/vnics/:vnicId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "vnics",
        ":vnicId"
      ],
      "variable": [
        {
          "key": "vnicId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
        }
      ]
    },
    "description": "Gets the information for the specified virtual network interface card (VNIC).\nYou can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the\n[ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation.\n"
  },
  "response": [
    {
      "name": "The VNIC was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/vnics/:vnicId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vnics",
            ":vnicId"
          ],
          "variable": [
            {
              "key": "vnicId"
            }
          ]
        }
      },
      "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 \"availabilityDomain\": \"irure esse ut aute do\",\n \"compartmentId\": \"commodo sed\",\n \"id\": \"Excepteur\",\n \"lifecycleState\": \"TERMINATED\",\n \"timeCreated\": \"1956-01-11T19:38:23.750Z\",\n \"definedTags\": {},\n \"displayName\": \"amet id qui ullamco \",\n \"freeformTags\": {},\n \"hostnameLabel\": \"culpa dolor Ut tempor quis\",\n \"isPrimary\": true,\n \"macAddress\": \"exercitation in\",\n \"nsgIds\": [\n  \"ut anim\",\n  \"in consectetur ut est\"\n ],\n \"privateIp\": \"laboris ullamco\",\n \"publicIp\": \"tempor cillum\",\n \"skipSourceDestCheck\": true,\n \"subnetId\": \"amet velit aliquip\",\n \"vlanId\": \"nisi ea sed\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/vnics/:vnicId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vnics",
            ":vnicId"
          ],
          "variable": [
            {
              "key": "vnicId"
            }
          ]
        }
      },
      "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}}/vnics/:vnicId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vnics",
            ":vnicId"
          ],
          "variable": [
            {
              "key": "vnicId"
            }
          ]
        }
      },
      "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}}/vnics/:vnicId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vnics",
            ":vnicId"
          ],
          "variable": [
            {
              "key": "vnicId"
            }
          ]
        }
      },
      "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}}/vnics/:vnicId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vnics",
            ":vnicId"
          ],
          "variable": [
            {
              "key": "vnicId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}