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, 'UpdateInt', @success OUT, 'limit', 801
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ipAddress', 'officia sed'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'subnetId', 'amet ut'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'vnicId', 'officia sed'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'vlanId', 'amet ut'
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/privateIps', @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)
-- [
-- {
-- "availabilityDomain": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "compartmentId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "definedTags": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "displayName": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "freeformTags": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "hostnameLabel": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "id": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "ipAddress": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "isPrimary": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "lifecycleState": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "subnetId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "timeCreated": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "vlanId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "vnicId": {
-- "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>"
-- },
-- "definedTags": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "displayName": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "freeformTags": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "hostnameLabel": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "id": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "ipAddress": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "isPrimary": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "lifecycleState": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "subnetId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "timeCreated": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "vlanId": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "vnicId": {
-- "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 @compartmentIdValue nvarchar(4000)
DECLARE @definedTagsValue nvarchar(4000)
DECLARE @displayNameValue nvarchar(4000)
DECLARE @freeformTagsValue nvarchar(4000)
DECLARE @hostnameLabelValue nvarchar(4000)
DECLARE @idValue nvarchar(4000)
DECLARE @ipAddressValue nvarchar(4000)
DECLARE @isPrimaryValue nvarchar(4000)
DECLARE @lifecycleStateValue nvarchar(4000)
DECLARE @subnetIdValue nvarchar(4000)
DECLARE @timeCreatedValue nvarchar(4000)
DECLARE @vlanIdValue nvarchar(4000)
DECLARE @vnicIdValue 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, 'availabilityDomain.value'
EXEC sp_OAMethod @json, 'StringOf', @compartmentIdValue OUT, 'compartmentId.value'
EXEC sp_OAMethod @json, 'StringOf', @definedTagsValue OUT, 'definedTags.value'
EXEC sp_OAMethod @json, 'StringOf', @displayNameValue OUT, 'displayName.value'
EXEC sp_OAMethod @json, 'StringOf', @freeformTagsValue OUT, 'freeformTags.value'
EXEC sp_OAMethod @json, 'StringOf', @hostnameLabelValue OUT, 'hostnameLabel.value'
EXEC sp_OAMethod @json, 'StringOf', @idValue OUT, 'id.value'
EXEC sp_OAMethod @json, 'StringOf', @ipAddressValue OUT, 'ipAddress.value'
EXEC sp_OAMethod @json, 'StringOf', @isPrimaryValue OUT, 'isPrimary.value'
EXEC sp_OAMethod @json, 'StringOf', @lifecycleStateValue OUT, 'lifecycleState.value'
EXEC sp_OAMethod @json, 'StringOf', @subnetIdValue OUT, 'subnetId.value'
EXEC sp_OAMethod @json, 'StringOf', @timeCreatedValue OUT, 'timeCreated.value'
EXEC sp_OAMethod @json, 'StringOf', @vlanIdValue OUT, 'vlanId.value'
EXEC sp_OAMethod @json, 'StringOf', @vnicIdValue OUT, 'vnicId.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 "limit=801"
-d "ipAddress=officia%20sed"
-d "subnetId=amet%20ut"
-d "vnicId=officia%20sed"
-d "vlanId=amet%20ut"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps
Postman Collection Item JSON
{
"name": "ListPrivateIps",
"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}}/privateIps?limit=801&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"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",
"disabled": true
},
{
"key": "ipAddress",
"value": "officia sed",
"description": "An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n"
},
{
"key": "subnetId",
"value": "amet ut",
"description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
},
{
"key": "vnicId",
"value": "officia sed",
"description": "The OCID of the VNIC."
},
{
"key": "vlanId",
"value": "amet ut",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
}
]
},
"description": "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based\non one of these filters:\n\n - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - Both private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp)\n requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nIf you're listing all the private IPs associated with a given subnet\nor VNIC, the response includes both primary and secondary private IPs.\n\nIf you are an Oracle Cloud VMware Solution customer and have VLANs\nin your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan).\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "ipAddress",
"value": "officia sed"
},
{
"key": "subnetId",
"value": "amet ut"
},
{
"key": "vnicId",
"value": "officia sed"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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 \"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 \"definedTags\": {\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 \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"hostnameLabel\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"ipAddress\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPrimary\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"subnetId\": {\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 \"vlanId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vnicId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\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 \"definedTags\": {\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 \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"hostnameLabel\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"ipAddress\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPrimary\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"subnetId\": {\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 \"vlanId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vnicId\": {\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}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "ipAddress",
"value": "officia sed"
},
{
"key": "subnetId",
"value": "amet ut"
},
{
"key": "vnicId",
"value": "officia sed"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "ipAddress",
"value": "officia sed"
},
{
"key": "subnetId",
"value": "amet ut"
},
{
"key": "vnicId",
"value": "officia sed"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "ipAddress",
"value": "officia sed"
},
{
"key": "subnetId",
"value": "amet ut"
},
{
"key": "vnicId",
"value": "officia sed"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "ipAddress",
"value": "officia sed"
},
{
"key": "subnetId",
"value": "amet ut"
},
{
"key": "vnicId",
"value": "officia sed"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "ipAddress",
"value": "officia sed"
},
{
"key": "subnetId",
"value": "amet ut"
},
{
"key": "vnicId",
"value": "officia sed"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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}"
}
]
}
