Chilkat Online Tools

Swift / Core Services API / GetBlockVolumeReplica

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.SetRequestHeader("Authorization", value: "{{signature}}")
    http.SetRequestHeader("Date", value: "{{date}}")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/blockVolumeReplicas/:blockVolumeReplicaId", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "id": "ea in fugiat",
    //   "availabilityDomain": "nisi cillum do elit",
    //   "sizeInGBs": 2853,
    //   "compartmentId": "Duis dolor",
    //   "displayName": "tempor cillum consequat",
    //   "timeCreated": "1994-05-04T07:42:04.840Z",
    //   "lifecycleState": "FAULTY",
    //   "timeLastSynced": "2006-11-07T06:32:00.457Z",
    //   "blockVolumeId": "sed reprehenderit",
    //   "definedTags": {},
    //   "freeformTags": {},
    //   "totalDataTransferredInGBs": 83632600
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var id: String? = jResp.StringOf("id")
    var availabilityDomain: String? = jResp.StringOf("availabilityDomain")
    var sizeInGBs: Int = jResp.IntOf("sizeInGBs").intValue
    var compartmentId: String? = jResp.StringOf("compartmentId")
    var displayName: String? = jResp.StringOf("displayName")
    var timeCreated: String? = jResp.StringOf("timeCreated")
    var lifecycleState: String? = jResp.StringOf("lifecycleState")
    var timeLastSynced: String? = jResp.StringOf("timeLastSynced")
    var blockVolumeId: String? = jResp.StringOf("blockVolumeId")
    var totalDataTransferredInGBs: Int = jResp.IntOf("totalDataTransferredInGBs").intValue

}

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/blockVolumeReplicas/:blockVolumeReplicaId

Postman Collection Item JSON

{
  "name": "GetBlockVolumeReplica",
  "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "blockVolumeReplicas",
        ":blockVolumeReplicaId"
      ],
      "variable": [
        {
          "key": "blockVolumeReplicaId",
          "value": "officia sed",
          "description": "(Required) The OCID of the block volume replica."
        }
      ]
    },
    "description": "Gets information for the specified block volume replica."
  },
  "response": [
    {
      "name": "The block volume replica's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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 \"id\": \"ea in fugiat\",\n \"availabilityDomain\": \"nisi cillum do elit\",\n \"sizeInGBs\": 2853,\n \"compartmentId\": \"Duis dolor\",\n \"displayName\": \"tempor cillum consequat\",\n \"timeCreated\": \"1994-05-04T07:42:04.840Z\",\n \"lifecycleState\": \"FAULTY\",\n \"timeLastSynced\": \"2006-11-07T06:32:00.457Z\",\n \"blockVolumeId\": \"sed reprehenderit\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"totalDataTransferredInGBs\": 83632600\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}