Chilkat Online Tools

TCL / Core Services API / GetDedicatedVmHost

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "opc-request-id" "8wF"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://iaas.{{region}}.oraclecloud.com/20160918/dedicatedVmHosts/:dedicatedVmHostId" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "availabilityDomain": "dolore amet Lorem qui",
#   "compartmentId": "aute deserunt",
#   "dedicatedVmHostShape": "Excepteur consectetur in id",
#   "displayName": "ut velit",
#   "id": "culpa ex do ut dolore",
#   "lifecycleState": "FAILED",
#   "remainingOcpus": 97024142.25815697,
#   "timeCreated": "2001-12-01T02:29:43.756Z",
#   "totalOcpus": 45411799.735526696,
#   "definedTags": {},
#   "faultDomain": "irure sed occaecat",
#   "freeformTags": {},
#   "remainingMemoryInGBs": 72785268.53741956,
#   "totalMemoryInGBs": 67123091.79214175
# }

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

set availabilityDomain [CkJsonObject_stringOf $jResp "availabilityDomain"]
set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set dedicatedVmHostShape [CkJsonObject_stringOf $jResp "dedicatedVmHostShape"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set id [CkJsonObject_stringOf $jResp "id"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set remainingOcpus [CkJsonObject_stringOf $jResp "remainingOcpus"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]
set totalOcpus [CkJsonObject_stringOf $jResp "totalOcpus"]
set faultDomain [CkJsonObject_stringOf $jResp "faultDomain"]
set remainingMemoryInGBs [CkJsonObject_stringOf $jResp "remainingMemoryInGBs"]
set totalMemoryInGBs [CkJsonObject_stringOf $jResp "totalMemoryInGBs"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "opc-request-id: 8wF"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/dedicatedVmHosts/:dedicatedVmHostId

Postman Collection Item JSON

{
  "name": "GetDedicatedVmHost",
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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}}/dedicatedVmHosts/:dedicatedVmHostId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "dedicatedVmHosts",
        ":dedicatedVmHostId"
      ],
      "variable": [
        {
          "key": "dedicatedVmHostId",
          "value": "officia sed",
          "description": "(Required) The OCID of the dedicated VM host."
        }
      ]
    },
    "description": "Gets information about the specified dedicated virtual machine host."
  },
  "response": [
    {
      "name": "The dedicated virtual machine host was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "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\": \"dolore amet Lorem qui\",\n \"compartmentId\": \"aute deserunt\",\n \"dedicatedVmHostShape\": \"Excepteur consectetur in id\",\n \"displayName\": \"ut velit\",\n \"id\": \"culpa ex do ut dolore\",\n \"lifecycleState\": \"FAILED\",\n \"remainingOcpus\": 97024142.25815697,\n \"timeCreated\": \"2001-12-01T02:29:43.756Z\",\n \"totalOcpus\": 45411799.735526696,\n \"definedTags\": {},\n \"faultDomain\": \"irure sed occaecat\",\n \"freeformTags\": {},\n \"remainingMemoryInGBs\": 72785268.53741956,\n \"totalMemoryInGBs\": 67123091.79214175\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}