Chilkat Online Tools

PureBasic / Core Services API / GetInstancePoolInstance

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/instancePools/:instancePoolId/instances/:instanceId",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": "occaecat magna dolor laborum",
    ;   "instancePoolId": "sit dolore",
    ;   "availabilityDomain": "aute",
    ;   "lifecycleState": "ACTIVE",
    ;   "compartmentId": "voluptate",
    ;   "instanceConfigurationId": "dolore nulla",
    ;   "region": "cillum dolore",
    ;   "shape": "consectetur non",
    ;   "state": "do ea",
    ;   "timeCreated": "2002-02-20T04:20:40.004Z",
    ;   "displayName": "velit anim",
    ;   "faultDomain": "commodo elit ex",
    ;   "loadBalancerBackends": [
    ;     {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     },
    ;     {
    ;       "value": "<Error: Too many levels of nesting to fake this schema>"
    ;     }
    ;   ]
    ; }

    ; 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")
    instancePoolId.s = CkJsonObject::ckStringOf(jResp,"instancePoolId")
    availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
    lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
    compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
    instanceConfigurationId.s = CkJsonObject::ckStringOf(jResp,"instanceConfigurationId")
    region.s = CkJsonObject::ckStringOf(jResp,"region")
    shape.s = CkJsonObject::ckStringOf(jResp,"shape")
    state.s = CkJsonObject::ckStringOf(jResp,"state")
    timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
    displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
    faultDomain.s = CkJsonObject::ckStringOf(jResp,"faultDomain")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"loadBalancerBackends")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        value = CkJsonObject::ckStringOf(jResp,"loadBalancerBackends[i].value")
        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/instancePools/:instancePoolId/instances/:instanceId

Postman Collection Item JSON

{
  "name": "GetInstancePoolInstance",
  "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}}/instancePools/:instancePoolId/instances/:instanceId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "instancePools",
        ":instancePoolId",
        "instances",
        ":instanceId"
      ],
      "variable": [
        {
          "key": "instancePoolId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
        },
        {
          "key": "instanceId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
        }
      ]
    },
    "description": "Gets information about an instance that belongs to an instance pool."
  },
  "response": [
    {
      "name": "The instance was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instancePools/:instancePoolId/instances/:instanceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instancePools",
            ":instancePoolId",
            "instances",
            ":instanceId"
          ],
          "variable": [
            {
              "key": "instancePoolId"
            },
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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\": \"occaecat magna dolor laborum\",\n \"instancePoolId\": \"sit dolore\",\n \"availabilityDomain\": \"aute\",\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"voluptate\",\n \"instanceConfigurationId\": \"dolore nulla\",\n \"region\": \"cillum dolore\",\n \"shape\": \"consectetur non\",\n \"state\": \"do ea\",\n \"timeCreated\": \"2002-02-20T04:20:40.004Z\",\n \"displayName\": \"velit anim\",\n \"faultDomain\": \"commodo elit ex\",\n \"loadBalancerBackends\": [\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}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instancePools/:instancePoolId/instances/:instanceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instancePools",
            ":instancePoolId",
            "instances",
            ":instanceId"
          ],
          "variable": [
            {
              "key": "instancePoolId"
            },
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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}}/instancePools/:instancePoolId/instances/:instanceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instancePools",
            ":instancePoolId",
            "instances",
            ":instanceId"
          ],
          "variable": [
            {
              "key": "instancePoolId"
            },
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instancePools/:instancePoolId/instances/:instanceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instancePools",
            ":instancePoolId",
            "instances",
            ":instanceId"
          ],
          "variable": [
            {
              "key": "instancePoolId"
            },
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instancePools/:instancePoolId/instances/:instanceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instancePools",
            ":instancePoolId",
            "instances",
            ":instanceId"
          ],
          "variable": [
            {
              "key": "instancePoolId"
            },
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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}}/instancePools/:instancePoolId/instances/:instanceId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instancePools",
            ":instancePoolId",
            "instances",
            ":instanceId"
          ],
          "variable": [
            {
              "key": "instancePoolId"
            },
            {
              "key": "instanceId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}