POST /v1beta/:tenantId/profiles — soda-api

Profiles

Creates a profile.

post/v1beta/{tenantId}/profiles

Request body

namestring required

The name of the profile

storageType'block' | 'file' | 'object' required

The type of the storage. It can be either block, file or object

descriptionstring

The description of the profile

customPropertiesCustomPropertiesSpec

CustomPropertiesSpec is a map of keys and JSON object that represents the customized properties of profile, such as requested capabilities including disk type, latency, de-duplicaiton, compression and so forth.

Example request

{
  "name": "File_Profile",
  "storageType": "block",
  "provisioningProperties": {
    "dataStorage": {
      "recoveryTimeObjective": 10,
      "characterCodeSet": "ASCII",
      "maxFileNameLengthBytes": 255
    },
    "ioConnectivity": {
      "accessProtocol": "iscsi",
      "maxIOPS": 150,
      "minIOPS": 50,
      "maxBWS": 5,
      "minBWS": 1,
      "latency": 1
    }
  },
  "replicationProperties": {
    "dataProtection": {
      "isIsolated": true,
      "minLifetime": "P3Y6M4DT12H30M5S",
      "RecoveryGeographicObjective": "datacenter",
      "RecoveryPointObjectiveTime": "P3Y6M4DT12H30M5S",
      "RecoveryTimeObjective": "offline",
      "ReplicaType": "snapshot"
    },
    "replicaInfos": {
      "replicaUpdateMode": "Active",
      "replcationBandwidth": 5,
      "replicationPeriod": "P3Y6M4DT12H30M5S",
      "consistencyEnalbed": true
    }
  },
  "snapshotProperties": {
    "schedule": {
      "datetime": "2019-09-07T07:02:35.389",
      "occurrence": "Daily"
    },
    "retention": {
      "duration": 15,
      "number": 10
    }
  },
  "dataProtectionProperties": {
    "dataProtection": {
      "isIsolated": true,
      "minLifetime": "P3Y6M4DT12H30M5S",
      "RecoveryGeographicObjective": "datacenter",
      "RecoveryPointObjectiveTime": "P3Y6M4DT12H30M5S",
      "RecoveryTimeObjective": "offline",
      "ReplicaType": "snapshot"
    },
    "consistencyEnalbed": true
  },
  "customProperties": {
    "key1": "value1",
    "key2": false,
    "key3": {
      "key31": "value31"
    }
  }
}

Response

Created

idstring

createdAtstring date-time

updatedAtstring date-time

namestring

The name of the profile

storageType'block' | 'file' | 'object'

The type of the storage. It can be either block, file or object

descriptionstring

The is description of the profile

customPropertiesCustomPropertiesSpec

Example response

{
  "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
  "createdAt": "2017-07-10T14:36:58.014Z",
  "updatedAt": "2017-07-10T14:36:58.014Z",
  "name": "File_Profile",
  "storageType": "block",
  "provisioningProperties": {
    "dataStorage": {
      "recoveryTimeObjective": 10,
      "characterCodeSet": "ASCII",
      "maxFileNameLengthBytes": 255
    },
    "ioConnectivity": {
      "accessProtocol": "iscsi",
      "maxIOPS": 150,
      "minIOPS": 50,
      "maxBWS": 5,
      "minBWS": 1,
      "latency": 1
    }
  },
  "replicationProperties": {
    "dataProtection": {
      "isIsolated": true,
      "minLifetime": "P3Y6M4DT12H30M5S",
      "RecoveryGeographicObjective": "datacenter",
      "RecoveryPointObjectiveTime": "P3Y6M4DT12H30M5S",
      "RecoveryTimeObjective": "offline",
      "ReplicaType": "snapshot"
    },
    "replicaInfos": {
      "replicaUpdateMode": "Active",
      "replcationBandwidth": 5,
      "replicationPeriod": "P3Y6M4DT12H30M5S",
      "consistencyEnalbed": true
    }
  },
  "snapshotProperties": {
    "schedule": {
      "datetime": "2019-09-07T07:02:35.389",
      "occurrence": "Daily"
    },
    "retention": {
      "duration": 15,
      "number": 10
    }
  },
  "dataProtectionProperties": {
    "dataProtection": {
      "isIsolated": true,
      "minLifetime": "P3Y6M4DT12H30M5S",
      "RecoveryGeographicObjective": "datacenter",
      "RecoveryPointObjectiveTime": "P3Y6M4DT12H30M5S",
      "RecoveryTimeObjective": "offline",
      "ReplicaType": "snapshot"
    },
    "consistencyEnalbed": true
  },
  "customProperties": {
    "key1": "value1",
    "key2": false,
    "key3": {
      "key31": "value31"
    }
  }
}

Changes

Changed in 7 of the 50 revisions of this API.18431

Feb 7, 2020fe6600fe75461See the full diff
- ○
  the / response's property pattern was changed from ^(([a-zA-Z0-9_-]|[a-zA-Z0-9_-][a-zA-Z0-9_-]*[a-zA-Z0-9_-]))*([A-Za-z0-9_-]|[A-Za-z0-9_-][A-Za-z0-9_-]*[A-Za-z0-9_-])$ to ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-\_]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-\_]*[A-Za-z0-9])$ for the status
  response-property-pattern-changed
Feb 7, 20203ee778b81b921See the full diff
- ○
  the / response's property pattern was changed from [A-Za-z0-9_-] to ^(([a-zA-Z0-9_-]|[a-zA-Z0-9_-][a-zA-Z0-9_-]*[a-zA-Z0-9_-]))*([A-Za-z0-9_-]|[A-Za-z0-9_-][A-Za-z0-9_-]*[A-Za-z0-9_-])$ for the status
  response-property-pattern-changed
Dec 5, 20190d720ad6985a418See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  the request's body type changed from no type to object
  request-body-type-changed
- ▲
  removed the success response with the status
  response-success-status-removed
- ●
  removed subschema #2 from the request body allOf list
  request-body-all-of-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  request body became optional
  request-body-became-optional
- ○
  added the success response with the status
  response-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 22, 2019a41e1157d0e7815See the full diff
- ▲
  removed the enum value Execute of the request property ///
  request-property-enum-value-removed
- ▲
  removed the enum value Read of the request property ///
  request-property-enum-value-removed
- ▲
  removed the enum value Write of the request property ///
  request-property-enum-value-removed
- ▲
  the // request property type changed from object to no type
  request-property-type-changed
- ▲
  the /// request property type changed from string to array
  request-property-type-changed
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the /// response's property type changed from string to array for status
  response-property-type-changed
- ●
  added the new NFS enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  the request property /// became optional
  request-property-became-optional
- ○
  added the new NFS enum value to the request property ///
  request-property-enum-value-added
- ○
  removed the Execute enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the Read enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the Write enum value from the /// response property for the response status
  response-property-enum-value-removed
Nov 20, 201964d46542013a210See the full diff
- ●
  removed the request property ///
  request-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 6, 2019fd0669e1e56f15See the full diff
- ▲
  added required request body
  request-body-added-required
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 4, 20183a7682f5369d51See the full diff
- ▲
  removed the request body
  request-body-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history