Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAvailabilityDomain
String sCompartmentId
String sDisplayName
String sHostnameLabel
String sId
String sIpAddress
Boolean iIsPrimary
String sLifecycleState
String sSubnetId
String sTimeCreated
String sVlanId
String sVnicId
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "availabilityDomain": "Excepteur",
// "compartmentId": "dolore est sed",
// "definedTags": {},
// "displayName": "amet dolor qui fugiat",
// "freeformTags": {},
// "hostnameLabel": "pariatur Lorem in",
// "id": "qui Ut",
// "ipAddress": "proident irure non enim",
// "isPrimary": true,
// "lifecycleState": "TERMINATING",
// "subnetId": "velit tempor officia incididunt ullamco",
// "timeCreated": "2011-12-31T21:46:36.823Z",
// "vlanId": "ut ullamco reprehenderit",
// "vnicId": "magna"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "availabilityDomain" To sAvailabilityDomain
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "hostnameLabel" To sHostnameLabel
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "ipAddress" To sIpAddress
Get ComBoolOf Of hoJResp "isPrimary" To iIsPrimary
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "subnetId" To sSubnetId
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
Get ComStringOf Of hoJResp "vlanId" To sVlanId
Get ComStringOf Of hoJResp "vnicId" To sVnicId
End_Procedure
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId
Postman Collection Item JSON
{
"name": "GetPrivateIp",
"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/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
}
]
},
"description": "Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps)\nwith the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n"
},
"response": [
{
"name": "The private IP.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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 \"availabilityDomain\": \"Excepteur\",\n \"compartmentId\": \"dolore est sed\",\n \"definedTags\": {},\n \"displayName\": \"amet dolor qui fugiat\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"pariatur Lorem in\",\n \"id\": \"qui Ut\",\n \"ipAddress\": \"proident irure non enim\",\n \"isPrimary\": true,\n \"lifecycleState\": \"TERMINATING\",\n \"subnetId\": \"velit tempor officia incididunt ullamco\",\n \"timeCreated\": \"2011-12-31T21:46:36.823Z\",\n \"vlanId\": \"ut ullamco reprehenderit\",\n \"vnicId\": \"magna\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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}"
}
]
}
