SQL Server / Core Services API / ListInstancePoolInstances
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
DECLARE @iTmp0 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
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'compartmentId', '{{compartment_ocid}}'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'displayName', 'amet ut'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 801
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page', 'laboris proident officia tempor'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sortBy', 'TIMECREATED'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sortOrder', 'DESC'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://iaas.{{region}}.oraclecloud.com/20160918/instancePools/:instancePoolId/instances', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jarrResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonArray', @jarrResp OUT
EXEC sp_OAMethod @jarrResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jarrResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jarrResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- [
-- {
-- "id": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "availabilityDomain": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "compartmentId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "instanceConfigurationId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "region": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "state": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "timeCreated": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "displayName": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "faultDomain": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "loadBalancerBackends": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "shape": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "id": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "availabilityDomain": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "compartmentId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "instanceConfigurationId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "region": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "state": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "timeCreated": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "displayName": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "faultDomain": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "loadBalancerBackends": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "shape": {
-- "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 @json int
DECLARE @Value nvarchar(4000)
DECLARE @availabilityDomainValue nvarchar(4000)
DECLARE @compartmentIdValue nvarchar(4000)
DECLARE @instanceConfigurationIdValue nvarchar(4000)
DECLARE @regionValue nvarchar(4000)
DECLARE @stateValue nvarchar(4000)
DECLARE @timeCreatedValue nvarchar(4000)
DECLARE @displayNameValue nvarchar(4000)
DECLARE @faultDomainValue nvarchar(4000)
DECLARE @loadBalancerBackendsValue nvarchar(4000)
DECLARE @shapeValue nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAGetProperty @jarrResp, 'Size', @count_i OUT
WHILE @i < @count_i
BEGIN
EXEC sp_OAMethod @jarrResp, 'ObjectAt', @json OUT, @i
EXEC sp_OAMethod @json, 'StringOf', @Value OUT, 'id.value'
EXEC sp_OAMethod @json, 'StringOf', @availabilityDomainValue OUT, 'availabilityDomain.value'
EXEC sp_OAMethod @json, 'StringOf', @compartmentIdValue OUT, 'compartmentId.value'
EXEC sp_OAMethod @json, 'StringOf', @instanceConfigurationIdValue OUT, 'instanceConfigurationId.value'
EXEC sp_OAMethod @json, 'StringOf', @regionValue OUT, 'region.value'
EXEC sp_OAMethod @json, 'StringOf', @stateValue OUT, 'state.value'
EXEC sp_OAMethod @json, 'StringOf', @timeCreatedValue OUT, 'timeCreated.value'
EXEC sp_OAMethod @json, 'StringOf', @displayNameValue OUT, 'displayName.value'
EXEC sp_OAMethod @json, 'StringOf', @faultDomainValue OUT, 'faultDomain.value'
EXEC sp_OAMethod @json, 'StringOf', @loadBalancerBackendsValue OUT, 'loadBalancerBackends.value'
EXEC sp_OAMethod @json, 'StringOf', @shapeValue OUT, 'shape.value'
EXEC @hr = sp_OADestroy @json
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
END
GO
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "displayName=amet%20ut"
-d "limit=801"
-d "page=laboris%20proident%20officia%20tempor"
-d "sortBy=TIMECREATED"
-d "sortOrder=DESC"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/instancePools/:instancePoolId/instances
Postman Collection Item JSON
{
"name": "ListInstancePoolInstances",
"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?compartmentId={{compartment_ocid}}&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "displayName",
"value": "amet ut",
"description": "A filter to return only resources that match the given display name exactly.\n"
},
{
"key": "limit",
"value": "801",
"description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
},
{
"key": "page",
"value": "laboris proident officia tempor",
"description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
},
{
"key": "sortBy",
"value": "TIMECREATED",
"description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
}
],
"variable": [
{
"key": "instancePoolId",
"value": "officia sed",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
}
]
},
"description": "List the instances in the specified instance pool."
},
"response": [
{
"name": "The list is being retrieved",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/instancePools/:instancePoolId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "instancePoolId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-next-page",
"value": "officia sed",
"description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"availabilityDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"instanceConfigurationId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"region\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"state\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"faultDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"loadBalancerBackends\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"shape\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"availabilityDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"instanceConfigurationId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"region\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"state\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"faultDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"loadBalancerBackends\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"shape\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/instancePools/:instancePoolId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "instancePoolId"
}
]
}
},
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/instancePools/:instancePoolId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "instancePoolId"
}
]
}
},
"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?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "instancePoolId"
}
]
}
},
"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": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/instancePools/:instancePoolId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "instancePoolId"
}
]
}
},
"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?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"instancePools",
":instancePoolId",
"instances"
],
"query": [
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "instancePoolId"
}
]
}
},
"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}"
}
]
}
