Chilkat Online Tools

SQL Server / Core Services API / GetInstancePoolInstance

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/instancePools/:instancePoolId/instances/:instanceId', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

    -- 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

    DECLARE @value nvarchar(4000)

    DECLARE @id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
    DECLARE @instancePoolId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @instancePoolId OUT, 'instancePoolId'
    DECLARE @availabilityDomain nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
    DECLARE @lifecycleState nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
    DECLARE @compartmentId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
    DECLARE @instanceConfigurationId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @instanceConfigurationId OUT, 'instanceConfigurationId'
    DECLARE @region nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @region OUT, 'region'
    DECLARE @shape nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @shape OUT, 'shape'
    DECLARE @state nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @state OUT, 'state'
    DECLARE @timeCreated nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
    DECLARE @displayName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
    DECLARE @faultDomain nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @faultDomain OUT, 'faultDomain'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'loadBalancerBackends'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'loadBalancerBackends[i].value'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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}"
    }
  ]
}