Chilkat Online Tools

PureBasic / Core Services API / GetComputeCapacityReservation

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,"opc-request-id","8wF")
    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/computeCapacityReservations/:capacityReservationId",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)

    ; {
    ;   "id": "proident in",
    ;   "compartmentId": "exercitation irure ipsum sunt",
    ;   "lifecycleState": "UPDATING",
    ;   "timeCreated": "1966-04-16T17:31:55.505Z",
    ;   "availabilityDomain": "aliquip tempor eu commodo",
    ;   "definedTags": {},
    ;   "displayName": "sunt tempor est",
    ;   "freeformTags": {},
    ;   "instanceReservationConfigs": [
    ;     {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   ],
    ;   "isDefaultReservation": false,
    ;   "reservedInstanceCount": 259123,
    ;   "timeUpdated": "1989-02-10T18:54:59.594Z",
    ;   "usedInstanceCount": -84257130
    ; }

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

    value.s

    id.s = CkJsonObject::ckStringOf(jResp,"id")
    compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
    lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
    timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
    availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
    displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
    isDefaultReservation.i = CkJsonObject::ckBoolOf(jResp,"isDefaultReservation")
    reservedInstanceCount.i = CkJsonObject::ckIntOf(jResp,"reservedInstanceCount")
    timeUpdated.s = CkJsonObject::ckStringOf(jResp,"timeUpdated")
    usedInstanceCount.i = CkJsonObject::ckIntOf(jResp,"usedInstanceCount")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"instanceReservationConfigs")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        value = CkJsonObject::ckStringOf(jResp,"instanceReservationConfigs[i].value")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetComputeCapacityReservation",
  "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}}/computeCapacityReservations/:capacityReservationId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "computeCapacityReservations",
        ":capacityReservationId"
      ],
      "variable": [
        {
          "key": "capacityReservationId",
          "value": "officia sed",
          "description": "(Required) The OCID of the compute capacity reservation."
        }
      ]
    },
    "description": "Gets information about the specified compute capacity reservation."
  },
  "response": [
    {
      "name": "The compute capacity reservation's information 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}}/computeCapacityReservations/:capacityReservationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeCapacityReservations",
            ":capacityReservationId"
          ],
          "variable": [
            {
              "key": "capacityReservationId"
            }
          ]
        }
      },
      "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\": \"proident in\",\n \"compartmentId\": \"exercitation irure ipsum sunt\",\n \"lifecycleState\": \"UPDATING\",\n \"timeCreated\": \"1966-04-16T17:31:55.505Z\",\n \"availabilityDomain\": \"aliquip tempor eu commodo\",\n \"definedTags\": {},\n \"displayName\": \"sunt tempor est\",\n \"freeformTags\": {},\n \"instanceReservationConfigs\": [\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 \"isDefaultReservation\": false,\n \"reservedInstanceCount\": 259123,\n \"timeUpdated\": \"1989-02-10T18:54:59.594Z\",\n \"usedInstanceCount\": -84257130\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}}/computeCapacityReservations/:capacityReservationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeCapacityReservations",
            ":capacityReservationId"
          ],
          "variable": [
            {
              "key": "capacityReservationId"
            }
          ]
        }
      },
      "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}}/computeCapacityReservations/:capacityReservationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeCapacityReservations",
            ":capacityReservationId"
          ],
          "variable": [
            {
              "key": "capacityReservationId"
            }
          ]
        }
      },
      "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": "Too many requests",
      "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}}/computeCapacityReservations/:capacityReservationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeCapacityReservations",
            ":capacityReservationId"
          ],
          "variable": [
            {
              "key": "capacityReservationId"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_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}}/computeCapacityReservations/:capacityReservationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeCapacityReservations",
            ":capacityReservationId"
          ],
          "variable": [
            {
              "key": "capacityReservationId"
            }
          ]
        }
      },
      "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}}/computeCapacityReservations/:capacityReservationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "computeCapacityReservations",
            ":capacityReservationId"
          ],
          "variable": [
            {
              "key": "capacityReservationId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}