Ruby / Core Services API / ListComputeCapacityReservationInstances
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.UpdateInt("limit",801)
queryParams.UpdateString("page","laboris proident officia tempor")
queryParams.UpdateString("sortBy","TIMECREATED")
queryParams.UpdateString("sortOrder","DESC")
http.SetRequestHeader("opc-request-id","8wF")
http.SetRequestHeader("Authorization","{{signature}}")
http.SetRequestHeader("Date","{{date}}")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/computeCapacityReservations/:capacityReservationId/instances",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>"
# },
# "availabilityDomain": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "compartmentId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "shape": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "faultDomain": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "shapeConfig": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "id": {
# "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>"
# },
# "shape": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "faultDomain": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "shapeConfig": {
# "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")
availabilityDomainValue = json.stringOf("availabilityDomain.value")
compartmentIdValue = json.stringOf("compartmentId.value")
shapeValue = json.stringOf("shape.value")
faultDomainValue = json.stringOf("faultDomain.value")
shapeConfigValue = json.stringOf("shapeConfig.value")
i = i + 1
end
Curl Command
curl -G -d "availabilityDomain=officia%20sed"
-d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-d "page=laboris%20proident%20officia%20tempor"
-d "sortBy=TIMECREATED"
-d "sortOrder=DESC"
-H "opc-request-id: 8wF"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/computeCapacityReservations/:capacityReservationId/instances
Postman Collection Item JSON
{
"name": "ListComputeCapacityReservationInstances",
"request": {
"method": "GET",
"header": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
},
{
"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}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId={{compartment_ocid}}&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"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": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"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": "sortBy",
"value": "TIMECREATED",
"description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
}
],
"variable": [
{
"key": "capacityReservationId",
"value": "officia sed",
"description": "(Required) The OCID of the compute capacity reservation."
}
]
},
"description": "Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"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 \"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 \"shape\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"faultDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"shapeConfig\": {\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 \"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 \"shape\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"faultDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"shapeConfig\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"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": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"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": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_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": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"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": [
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"url": {
"raw": "{{baseUrl}}/computeCapacityReservations/:capacityReservationId/instances?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
"host": [
"{{baseUrl}}"
],
"path": [
"computeCapacityReservations",
":capacityReservationId",
"instances"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
}
],
"variable": [
{
"key": "capacityReservationId"
}
]
}
},
"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}"
}
]
}
