Chilkat Online Tools

phpAx / Core Services API / AttachVolume

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "instanceId": "consequat laboris",
//   "volumeId": "nulla dolor consectetur Duis",
//   "type": "in occaecat velit in",
//   "device": "Duis",
//   "displayName": "dolore enim cillum",
//   "isReadOnly": false,
//   "isShareable": true
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('instanceId','consequat laboris');
$json->UpdateString('volumeId','nulla dolor consectetur Duis');
$json->UpdateString('type','in occaecat velit in');
$json->UpdateString('device','Duis');
$json->UpdateString('displayName','dolore enim cillum');
$json->UpdateBool('isReadOnly',0);
$json->UpdateBool('isShareable',1);

$http->SetRequestHeader('opc-retry-token','aliqua enim i');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('x-content-sha256','{{content_sha256}}');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "id": "ipsum minim",
//   "attachmentType": "non",
//   "instanceId": "esse ea sint",
//   "volumeId": "minim occaecat in est anim",
//   "lifecycleState": "ATTACHING",
//   "compartmentId": "eu ex sunt",
//   "availabilityDomain": "magna proident",
//   "timeCreated": "1954-08-02T00:08:02.631Z",
//   "device": "consequat Lorem",
//   "displayName": "cupidatat do dolore cillum",
//   "isMultipath": false,
//   "isPvEncryptionInTransitEnabled": true,
//   "isReadOnly": true,
//   "isShareable": true,
//   "iscsiLoginState": "UNKNOWN"
// }

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

$id = $jResp->stringOf('id');
$attachmentType = $jResp->stringOf('attachmentType');
$instanceId = $jResp->stringOf('instanceId');
$volumeId = $jResp->stringOf('volumeId');
$lifecycleState = $jResp->stringOf('lifecycleState');
$compartmentId = $jResp->stringOf('compartmentId');
$availabilityDomain = $jResp->stringOf('availabilityDomain');
$timeCreated = $jResp->stringOf('timeCreated');
$device = $jResp->stringOf('device');
$displayName = $jResp->stringOf('displayName');
$isMultipath = $jResp->BoolOf('isMultipath');
$isPvEncryptionInTransitEnabled = $jResp->BoolOf('isPvEncryptionInTransitEnabled');
$isReadOnly = $jResp->BoolOf('isReadOnly');
$isShareable = $jResp->BoolOf('isShareable');
$iscsiLoginState = $jResp->stringOf('iscsiLoginState');

?>

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "instanceId": "consequat laboris",
    "volumeId": "nulla dolor consectetur Duis",
    "type": "in occaecat velit in",
    "device": "Duis",
    "displayName": "dolore enim cillum",
    "isReadOnly": false,
    "isShareable": true
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/

Postman Collection Item JSON

{
  "name": "AttachVolume",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeAttachments/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeAttachments",
        ""
      ]
    },
    "description": "Attaches the specified storage volume to the specified instance.\n"
  },
  "response": [
    {
      "name": "The volume is being attached.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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\": \"ipsum minim\",\n \"attachmentType\": \"non\",\n \"instanceId\": \"esse ea sint\",\n \"volumeId\": \"minim occaecat in est anim\",\n \"lifecycleState\": \"ATTACHING\",\n \"compartmentId\": \"eu ex sunt\",\n \"availabilityDomain\": \"magna proident\",\n \"timeCreated\": \"1954-08-02T00:08:02.631Z\",\n \"device\": \"consequat Lorem\",\n \"displayName\": \"cupidatat do dolore cillum\",\n \"isMultipath\": false,\n \"isPvEncryptionInTransitEnabled\": true,\n \"isReadOnly\": true,\n \"isShareable\": true,\n \"iscsiLoginState\": \"UNKNOWN\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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}"
    }
  ]
}