Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("availabilityDomain","officia sed")
success = queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
success = queryParams.UpdateInt("limit",801)
success = queryParams.UpdateString("page","laboris proident officia tempor")
success = queryParams.UpdateString("displayName","amet ut")
success = queryParams.UpdateString("sortBy","TIMECREATED")
success = queryParams.UpdateString("sortOrder","DESC")
success = queryParams.UpdateString("lifecycleState","officia sed")
http.SetRequestHeader "Authorization","{{signature}}"
http.SetRequestHeader "Date","{{date}}"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jarrResp As New ChilkatJsonArray
success = jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jarrResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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>"
' },
' "volumeIds": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "availabilityDomain": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "displayName": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "sizeInMBs": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "compartmentId": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "timeCreated": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "lifecycleState": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "definedTags": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "freeformTags": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "isHydrated": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "sizeInGBs": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "sourceDetails": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' }
' },
' {
' "id": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "volumeIds": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "availabilityDomain": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "displayName": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "sizeInMBs": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "compartmentId": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "timeCreated": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "lifecycleState": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "definedTags": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "freeformTags": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "isHydrated": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "sizeInGBs": {
' "value": "<Error: Too many levels of nesting to fake this schema>"
' },
' "sourceDetails": {
' "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
Dim json As ChilkatJsonObject
Dim Value As String
Dim volumeIdsValue As String
Dim availabilityDomainValue As String
Dim displayNameValue As String
Dim sizeInMBsValue As String
Dim compartmentIdValue As String
Dim timeCreatedValue As String
Dim lifecycleStateValue As String
Dim definedTagsValue As String
Dim freeformTagsValue As String
Dim isHydratedValue As String
Dim sizeInGBsValue As String
Dim sourceDetailsValue As String
Dim i As Long
i = 0
Dim count_i As Long
count_i = jarrResp.Size
Do While i < count_i
Set json = jarrResp.ObjectAt(i)
Value = json.StringOf("id.value")
volumeIdsValue = json.StringOf("volumeIds.value")
availabilityDomainValue = json.StringOf("availabilityDomain.value")
displayNameValue = json.StringOf("displayName.value")
sizeInMBsValue = json.StringOf("sizeInMBs.value")
compartmentIdValue = json.StringOf("compartmentId.value")
timeCreatedValue = json.StringOf("timeCreated.value")
lifecycleStateValue = json.StringOf("lifecycleState.value")
definedTagsValue = json.StringOf("definedTags.value")
freeformTagsValue = json.StringOf("freeformTags.value")
isHydratedValue = json.StringOf("isHydrated.value")
sizeInGBsValue = json.StringOf("sizeInGBs.value")
sourceDetailsValue = json.StringOf("sourceDetails.value")
i = i + 1
Loop
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 "displayName=amet%20ut"
-d "sortBy=TIMECREATED"
-d "sortOrder=DESC"
-d "lifecycleState=officia%20sed"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups
Postman Collection Item JSON
{
"name": "ListVolumeGroups",
"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}}/volumeGroups?availabilityDomain=officia sed&compartmentId={{compartment_ocid}}&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"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"
},
{
"key": "displayName",
"value": "amet ut",
"description": "A filter to return only resources that match the given display name exactly.\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"
},
{
"key": "lifecycleState",
"value": "officia sed",
"description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
}
]
},
"description": "Lists the volume groups in the specified compartment and availability domain.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroups?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"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 \"volumeIds\": {\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 \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInMBs\": {\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 \"timeCreated\": {\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 \"definedTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isHydrated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceDetails\": {\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 \"volumeIds\": {\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 \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInMBs\": {\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 \"timeCreated\": {\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 \"definedTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isHydrated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceDetails\": {\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}}/volumeGroups?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"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}}/volumeGroups?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"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}}/volumeGroups?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"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}}/volumeGroups?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"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}}/volumeGroups?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "displayName",
"value": "amet ut"
},
{
"key": "sortBy",
"value": "TIMECREATED"
},
{
"key": "sortOrder",
"value": "DESC"
},
{
"key": "lifecycleState",
"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}"
}
]
}
