Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
queryParams = chilkat2.JsonObject()
queryParams.UpdateString("availabilityDomain","officia sed")
queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
queryParams.UpdateInt("limit",801)
queryParams.UpdateString("instanceId","officia sed")
queryParams.UpdateString("volumeId","officia sed")
http.SetRequestHeader("Authorization","{{signature}}")
http.SetRequestHeader("Date","{{date}}")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/",queryParams)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jarrResp = chilkat2.JsonArray()
jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = False
print("Response Body:")
print(jarrResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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>"
# },
# "attachmentType": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "instanceId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "volumeId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "lifecycleState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "compartmentId": {
# "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>"
# },
# "device": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "displayName": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isMultipath": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isPvEncryptionInTransitEnabled": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isReadOnly": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isShareable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "iscsiLoginState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# {
# "id": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "attachmentType": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "instanceId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "volumeId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "lifecycleState": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "compartmentId": {
# "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>"
# },
# "device": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "displayName": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isMultipath": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isPvEncryptionInTransitEnabled": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isReadOnly": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "isShareable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "iscsiLoginState": {
# "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.Size
while i < count_i :
# json is a CkJsonObject
json = jarrResp.ObjectAt(i)
Value = json.StringOf("id.value")
attachmentTypeValue = json.StringOf("attachmentType.value")
instanceIdValue = json.StringOf("instanceId.value")
volumeIdValue = json.StringOf("volumeId.value")
lifecycleStateValue = json.StringOf("lifecycleState.value")
compartmentIdValue = json.StringOf("compartmentId.value")
availabilityDomainValue = json.StringOf("availabilityDomain.value")
timeCreatedValue = json.StringOf("timeCreated.value")
deviceValue = json.StringOf("device.value")
displayNameValue = json.StringOf("displayName.value")
isMultipathValue = json.StringOf("isMultipath.value")
isPvEncryptionInTransitEnabledValue = json.StringOf("isPvEncryptionInTransitEnabled.value")
isReadOnlyValue = json.StringOf("isReadOnly.value")
isShareableValue = json.StringOf("isShareable.value")
iscsiLoginStateValue = json.StringOf("iscsiLoginState.value")
i = i + 1
Curl Command
curl -G -d "availabilityDomain=officia%20sed"
-d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-d "instanceId=officia%20sed"
-d "volumeId=officia%20sed"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/
Postman Collection Item JSON
{
"name": "ListVolumeAttachments",
"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}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId={{compartment_ocid}}&limit=801&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"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": "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",
"disabled": true
},
{
"key": "instanceId",
"value": "officia sed",
"description": "The OCID of the instance."
},
{
"key": "volumeId",
"value": "officia sed",
"description": "The OCID of the volume."
}
]
},
"description": "Lists the volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, volume OCID, or both.\n\nCurrently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and\n[ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/).\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "volumeId",
"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 \"attachmentType\": {\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 \"volumeId\": {\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 \"compartmentId\": {\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 \"device\": {\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 \"isMultipath\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPvEncryptionInTransitEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isReadOnly\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isShareable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"iscsiLoginState\": {\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 \"attachmentType\": {\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 \"volumeId\": {\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 \"compartmentId\": {\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 \"device\": {\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 \"isMultipath\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPvEncryptionInTransitEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isReadOnly\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isShareable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"iscsiLoginState\": {\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}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "volumeId",
"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}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "volumeId",
"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}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "volumeId",
"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}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "volumeId",
"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}}/volumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&volumeId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "instanceId",
"value": "officia sed"
},
{
"key": "volumeId",
"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}"
}
]
}
