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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/subnets/:subnetId', @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
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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)
-- {
-- "vcnId": "enim non eu cillum",
-- "id": "eu incididunt tempor",
-- "compartmentId": "deserunt eu et v",
-- "cidrBlock": "minim",
-- "routeTableId": "veniam dolor voluptate m",
-- "virtualRouterIp": "dolore dolor ven",
-- "virtualRouterMac": "pariatur",
-- "lifecycleState": "AVAILABLE",
-- "availabilityDomain": "Lorem pariatur do",
-- "definedTags": {},
-- "dhcpOptionsId": "aute",
-- "displayName": "Duis ad eu sunt",
-- "dnsLabel": "eiusmod",
-- "freeformTags": {},
-- "ipv6CidrBlock": "adipisicing reprehende",
-- "ipv6PublicCidrBlock": "sed Lorem",
-- "ipv6VirtualRouterIp": "in ex cupidatat",
-- "prohibitPublicIpOnVnic": false,
-- "securityListIds": [
-- "dolore in enim",
-- "anim Lorem"
-- ],
-- "subnetDomainName": "labore cupidatat commodo",
-- "timeCreated": "1995-01-31T14:27:19.328Z"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @strVal nvarchar(4000)
DECLARE @vcnId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @vcnId OUT, 'vcnId'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @cidrBlock nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @cidrBlock OUT, 'cidrBlock'
DECLARE @routeTableId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @routeTableId OUT, 'routeTableId'
DECLARE @virtualRouterIp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @virtualRouterIp OUT, 'virtualRouterIp'
DECLARE @virtualRouterMac nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @virtualRouterMac OUT, 'virtualRouterMac'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @availabilityDomain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
DECLARE @dhcpOptionsId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @dhcpOptionsId OUT, 'dhcpOptionsId'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @dnsLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @dnsLabel OUT, 'dnsLabel'
DECLARE @ipv6CidrBlock nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ipv6CidrBlock OUT, 'ipv6CidrBlock'
DECLARE @ipv6PublicCidrBlock nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ipv6PublicCidrBlock OUT, 'ipv6PublicCidrBlock'
DECLARE @ipv6VirtualRouterIp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ipv6VirtualRouterIp OUT, 'ipv6VirtualRouterIp'
DECLARE @prohibitPublicIpOnVnic int
EXEC sp_OAMethod @jResp, 'BoolOf', @prohibitPublicIpOnVnic OUT, 'prohibitPublicIpOnVnic'
DECLARE @subnetDomainName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @subnetDomainName OUT, 'subnetDomainName'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'securityListIds'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'securityListIds[i]'
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/subnets/:subnetId
Postman Collection Item JSON
{
"name": "GetSubnet",
"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}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
}
]
},
"description": "Gets the specified subnet's information."
},
"response": [
{
"name": "The subnet was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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 \"vcnId\": \"enim non eu cillum\",\n \"id\": \"eu incididunt tempor\",\n \"compartmentId\": \"deserunt eu et v\",\n \"cidrBlock\": \"minim\",\n \"routeTableId\": \"veniam dolor voluptate m\",\n \"virtualRouterIp\": \"dolore dolor ven\",\n \"virtualRouterMac\": \"pariatur\",\n \"lifecycleState\": \"AVAILABLE\",\n \"availabilityDomain\": \"Lorem pariatur do\",\n \"definedTags\": {},\n \"dhcpOptionsId\": \"aute\",\n \"displayName\": \"Duis ad eu sunt\",\n \"dnsLabel\": \"eiusmod\",\n \"freeformTags\": {},\n \"ipv6CidrBlock\": \"adipisicing reprehende\",\n \"ipv6PublicCidrBlock\": \"sed Lorem\",\n \"ipv6VirtualRouterIp\": \"in ex cupidatat\",\n \"prohibitPublicIpOnVnic\": false,\n \"securityListIds\": [\n \"dolore in enim\",\n \"anim Lorem\"\n ],\n \"subnetDomainName\": \"labore cupidatat commodo\",\n \"timeCreated\": \"1995-01-31T14:27:19.328Z\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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}"
}
]
}
