PureBasic / Core Services API / CreateInternetGateway
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "compartmentId": "{{compartment_ocid}}",
; "vcnId": "ocid1.vcn.oc1...",
; "isEnabled": true,
; "definedTags": {},
; "displayName": "elit",
; "freeformTags": {}
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"compartmentId","{{compartment_ocid}}")
CkJsonObject::ckUpdateString(json,"vcnId","ocid1.vcn.oc1...")
CkJsonObject::ckUpdateBool(json,"isEnabled",1)
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","elit")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
CkHttp::ckSetRequestHeader(http,"opc-retry-token","aliqua enim i")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
resp.i = CkHttp::ckPostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "id": "quis laborum eu",
; "compartmentId": "sed",
; "lifecycleState": "AVAILABLE",
; "vcnId": "fugiat nostrud",
; "definedTags": {},
; "displayName": "Ut reprehend",
; "freeformTags": {},
; "isEnabled": true,
; "timeCreated": "1994-01-17T22:51:32.949Z"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s = CkJsonObject::ckStringOf(jResp,"id")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
vcnId.s = CkJsonObject::ckStringOf(jResp,"vcnId")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
isEnabled.i = CkJsonObject::ckBoolOf(jResp,"isEnabled")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "opc-retry-token: aliqua enim i"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"compartmentId": "{{compartment_ocid}}",
"vcnId": "ocid1.vcn.oc1...",
"isEnabled": true,
"definedTags": {},
"displayName": "elit",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways
Postman Collection Item JSON
{
"name": "CreateInternetGateway",
"request": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
},
{
"key": "x-content-sha256",
"value": "{{content_sha256}}",
"description": "(Required) Content sha256 for POST, PUT and PATCH operations",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"{{compartment_ocid}}\",\n \"vcnId\": \"ocid1.vcn.oc1...\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
},
"description": "Creates a new internet gateway for the specified VCN. For more information, see\n[Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet\nGateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or\nother Networking Service components. If you're not sure which compartment to use, put the Internet\nGateway in the same compartment with the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It\ndoes not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in\nthe subnet's route table (for example, 0.0.0.0/0 > internet gateway). See\n[UpdateRouteTable](#/en/iaas/latest/RouteTable/UpdateRouteTable).\n\nYou must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no\ntraffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later\nuse [UpdateInternetGateway](#/en/iaas/latest/InternetGateway/UpdateInternetGateway) to easily disable/enable\nthe gateway without changing the route rule.\n"
},
"response": [
{
"name": "The internet gateway was created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"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\": \"quis laborum eu\",\n \"compartmentId\": \"sed\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"fugiat nostrud\",\n \"definedTags\": {},\n \"displayName\": \"Ut reprehend\",\n \"freeformTags\": {},\n \"isEnabled\": true,\n \"timeCreated\": \"1994-01-17T22:51:32.949Z\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"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": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"status": "Conflict",
"code": 409,
"_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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"labore ut Duis magna\",\n \"vcnId\": \"consectetur ve\",\n \"isEnabled\": true,\n \"definedTags\": {},\n \"displayName\": \"elit\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/internetGateways",
"host": [
"{{baseUrl}}"
],
"path": [
"internetGateways"
]
}
},
"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}"
}
]
}
