Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("availabilityDomain","officia sed")
queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
queryParams.UpdateString("instanceId","officia sed")
queryParams.UpdateInt("limit",801)
queryParams.UpdateString("page","laboris proident officia tempor")
queryParams.UpdateString("vnicId","officia sed")
http.SetRequestHeader("Authorization","{{signature}}")
http.SetRequestHeader("Date","{{date}}")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/vnicAttachments/",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jarrResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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>"
# },
# "compartmentId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "instanceId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "lifecycleState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "availabilityDomain": {
# "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>"
# },
# "nicIndex": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "subnetId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vlanId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vlanTag": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vnicId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "id": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "compartmentId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "instanceId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "lifecycleState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "availabilityDomain": {
# "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>"
# },
# "nicIndex": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "subnetId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vlanId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vlanTag": {
# "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
i = 0
count_i = jarrResp.get_Size()
while i < count_i
# json is a CkJsonObject
json = jarrResp.ObjectAt(i)
Value = json.stringOf("id.value")
compartmentIdValue = json.stringOf("compartmentId.value")
instanceIdValue = json.stringOf("instanceId.value")
lifecycleStateValue = json.stringOf("lifecycleState.value")
availabilityDomainValue = json.stringOf("availabilityDomain.value")
timeCreatedValue = json.stringOf("timeCreated.value")
displayNameValue = json.stringOf("displayName.value")
nicIndexValue = json.stringOf("nicIndex.value")
subnetIdValue = json.stringOf("subnetId.value")
vlanIdValue = json.stringOf("vlanId.value")
vlanTagValue = json.stringOf("vlanTag.value")
vnicIdValue = json.stringOf("vnicId.value")
i = i + 1
end
Curl Command
curl -G -d "availabilityDomain=officia%20sed"
-d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "instanceId=officia%20sed"
-d "limit=801"
-d "page=laboris%20proident%20officia%20tempor"
-d "vnicId=officia%20sed"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/vnicAttachments/
Postman Collection Item JSON
{
"name": "ListVnicAttachments",
"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}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId={{compartment_ocid}}&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed",
"description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n"
},
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "instanceId",
"value": "officia sed",
"description": "The OCID of the instance."
},
{
"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": "vnicId",
"value": "officia sed",
"description": "The OCID of the VNIC."
}
]
},
"description": "Lists the VNIC attachments in the specified compartment. A VNIC attachment\nresides in the same compartment as the attached instance. The list can be\nfiltered by instance, VNIC, or availability domain.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vnicId",
"value": "officia sed"
}
]
}
},
"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 \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"instanceId\": {\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 \"availabilityDomain\": {\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 \"nicIndex\": {\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 \"vlanId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vlanTag\": {\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 \"id\": {\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 \"instanceId\": {\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 \"availabilityDomain\": {\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 \"nicIndex\": {\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 \"vlanId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vlanTag\": {\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}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vnicId",
"value": "officia sed"
}
]
}
},
"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}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vnicId",
"value": "officia sed"
}
]
}
},
"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}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vnicId",
"value": "officia sed"
}
]
}
},
"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}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vnicId",
"value": "officia sed"
}
]
}
},
"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}}/vnicAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor&vnicId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"vnicAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "vnicId",
"value": "officia sed"
}
]
}
},
"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}"
}
]
}
