Chilkat Online Tools

TCL / Core Services API / UpdateVolume

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]

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

# The following JSON is sent in the request body.

# {
#   "blockVolumeReplicas": [
#     {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     }
#   ],
#   "definedTags": {},
#   "displayName": "sunt non",
#   "freeformTags": {},
#   "isAutoTuneEnabled": true,
#   "sizeInGBs": -35753331,
#   "vpusPerGB": -34400178
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "blockVolumeReplicas[0].value" "<Error: Too many levels of nesting to fake this schema>"
CkJsonObject_UpdateNewObject $json "definedTags"
CkJsonObject_UpdateString $json "displayName" "sunt non"
CkJsonObject_UpdateNewObject $json "freeformTags"
CkJsonObject_UpdateBool $json "isAutoTuneEnabled" 1
CkJsonObject_UpdateInt $json "sizeInGBs" -35753331
CkJsonObject_UpdateInt $json "vpusPerGB" -34400178

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-content-sha256" "{{content_sha256}}"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"
CkHttp_SetRequestHeader $http "if-match" "officia sed"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

set resp [new_CkHttpResponse]

set success [CkHttp_HttpSb $http "PUT" "https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId" $sbRequestBody "utf-8" "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

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

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "id": "dolore magna fugiat",
#   "availabilityDomain": "ut",
#   "displayName": "ut velit commodo",
#   "sizeInMBs": -55113189,
#   "compartmentId": "et ullamco consequat u",
#   "timeCreated": "1988-12-07T08:21:37.359Z",
#   "lifecycleState": "PROVISIONING",
#   "autoTunedVpusPerGB": -84866272,
#   "blockVolumeReplicas": [
#     {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     }
#   ],
#   "definedTags": {},
#   "freeformTags": {},
#   "isAutoTuneEnabled": false,
#   "isHydrated": true,
#   "kmsKeyId": "ullamco",
#   "sizeInGBs": -13490866,
#   "sourceDetails": {
#     "type": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     }
#   },
#   "volumeGroupId": "proident eu velit",
#   "vpusPerGB": -99437639
# }

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

set id [CkJsonObject_stringOf $jResp "id"]
set availabilityDomain [CkJsonObject_stringOf $jResp "availabilityDomain"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set sizeInMBs [CkJsonObject_IntOf $jResp "sizeInMBs"]
set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set autoTunedVpusPerGB [CkJsonObject_IntOf $jResp "autoTunedVpusPerGB"]
set isAutoTuneEnabled [CkJsonObject_BoolOf $jResp "isAutoTuneEnabled"]
set isHydrated [CkJsonObject_BoolOf $jResp "isHydrated"]
set kmsKeyId [CkJsonObject_stringOf $jResp "kmsKeyId"]
set sizeInGBs [CkJsonObject_IntOf $jResp "sizeInGBs"]
set Value [CkJsonObject_stringOf $jResp "sourceDetails.type.value"]
set volumeGroupId [CkJsonObject_stringOf $jResp "volumeGroupId"]
set vpusPerGB [CkJsonObject_IntOf $jResp "vpusPerGB"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "blockVolumeReplicas"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set value [CkJsonObject_stringOf $jResp "blockVolumeReplicas[i].value"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "if-match: officia sed"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "blockVolumeReplicas": [
        {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    ],
    "definedTags": {},
    "displayName": "sunt non",
    "freeformTags": {},
    "isAutoTuneEnabled": true,
    "sizeInGBs": -35753331,
    "vpusPerGB": -34400178
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId

Postman Collection Item JSON

{
  "name": "UpdateVolume",
  "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"
      },
      {
        "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumes/:volumeId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumes",
        ":volumeId"
      ],
      "variable": [
        {
          "key": "volumeId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume."
        }
      ]
    },
    "description": "Updates the specified volume's display name.\nAvoid entering confidential information.\n"
  },
  "response": [
    {
      "name": "The volume 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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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\": \"dolore magna fugiat\",\n \"availabilityDomain\": \"ut\",\n \"displayName\": \"ut velit commodo\",\n \"sizeInMBs\": -55113189,\n \"compartmentId\": \"et ullamco consequat u\",\n \"timeCreated\": \"1988-12-07T08:21:37.359Z\",\n \"lifecycleState\": \"PROVISIONING\",\n \"autoTunedVpusPerGB\": -84866272,\n \"blockVolumeReplicas\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"definedTags\": {},\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": false,\n \"isHydrated\": true,\n \"kmsKeyId\": \"ullamco\",\n \"sizeInGBs\": -13490866,\n \"sourceDetails\": {\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"volumeGroupId\": \"proident eu velit\",\n \"vpusPerGB\": -99437639\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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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": "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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}