Chilkat Online Tools

Ruby / Core Services API / UpdateDedicatedVmHost

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "definedTags": {},
#   "displayName": "dolor culpa",
#   "freeformTags": {}
# }

json = Chilkat::CkJsonObject.new()
json.UpdateNewObject("definedTags")
json.UpdateString("displayName","dolor culpa")
json.UpdateNewObject("freeformTags")

http.SetRequestHeader("Date","{{date}}")
http.SetRequestHeader("opc-retry-token","aliqua enim i")
http.SetRequestHeader("if-match","officia sed")
http.SetRequestHeader("opc-request-id","8wF")
http.SetRequestHeader("x-content-sha256","{{content_sha256}}")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Authorization","{{signature}}")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/dedicatedVmHosts/:dedicatedVmHostId",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

availabilityDomain = jResp.stringOf("availabilityDomain")
compartmentId = jResp.stringOf("compartmentId")
dedicatedVmHostShape = jResp.stringOf("dedicatedVmHostShape")
displayName = jResp.stringOf("displayName")
id = jResp.stringOf("id")
lifecycleState = jResp.stringOf("lifecycleState")
remainingOcpus = jResp.stringOf("remainingOcpus")
timeCreated = jResp.stringOf("timeCreated")
totalOcpus = jResp.stringOf("totalOcpus")
faultDomain = jResp.stringOf("faultDomain")
remainingMemoryInGBs = jResp.stringOf("remainingMemoryInGBs")
totalMemoryInGBs = jResp.stringOf("totalMemoryInGBs")

Curl Command

curl -X PUT
	-H "if-match: officia sed"
	-H "opc-request-id: 8wF"
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "definedTags": {},
    "displayName": "dolor culpa",
    "freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/dedicatedVmHosts/:dedicatedVmHostId

Postman Collection Item JSON

{
  "name": "UpdateDedicatedVmHost",
  "request": {
    "method": "PUT",
    "header": [
      {
        "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
        "key": "if-match",
        "value": "officia sed"
      },
      {
        "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"
      },
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
    },
    "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": "Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.\nIf an attribute value is not included, it will not be updated.\n"
  },
  "response": [
    {
      "name": "The dedicated virtual machine host was updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "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": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "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": "Conflict",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": "Precondition Failed",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/dedicatedVmHosts/:dedicatedVmHostId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "dedicatedVmHosts",
            ":dedicatedVmHostId"
          ],
          "variable": [
            {
              "key": "dedicatedVmHostId"
            }
          ]
        }
      },
      "status": "Precondition Failed",
      "code": 412,
      "_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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "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"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolor culpa\",\n    \"freeformTags\": {}\n}"
        },
        "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}"
    }
  ]
}