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

Profiles

Lists information for all profiles.

get/v1beta/{tenantId}/profiles

Query parameters

limitinteger

Number of query results on multiple pages

offsetinteger

Start position of the pagination query

sortDir'asc' | 'desc'

Ascending or descending

sortKeystring

Sorting key word, such as name, createdAt

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

availabilityZonestring

status'available' | 'unavailable'

namestring

Response

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

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 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 9 of the 50 revisions of this API.111233

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
Feb 3, 2020f797fa1d87f72See the full diff
- ○
  added the new optional query request parameter availabilityZone
  new-optional-request-parameter
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
Dec 9, 2019b151718b45cf2See the full diff
- ▲
  removed the enum value createdAt from the query request parameter sortKey
  request-parameter-enum-value-removed
- ▲
  removed the enum value name from the query request parameter sortKey
  request-parameter-enum-value-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 5, 20190d720ad6985a2216See the full diff
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ●
  added the new DSWare enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new nvmeof enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter name
  new-optional-request-parameter
- ○
  added the new optional query request parameter offset
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortDir
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortKey
  new-optional-request-parameter
- ○
  added the new optional query request parameter storageType
  new-optional-request-parameter
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value thick was added for the status
  response-property-default-value-added
- ○
  removed the DSWARE enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  the // response's property pattern [A-Za-z0-9_-] was added for the status
  response-property-pattern-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 22, 2019a41e1157d0e7313See the full diff
- ▲
  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
- ○
  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, 201964d46542013a15See the full diff
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ○
  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, 2019fd0669e1e56f4See the full diff
- ○
  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, 20183a7682f5369d481See the full diff
- ▲
  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
- ●
  deleted the query request parameter availabilityZone
  request-parameter-removed
- ●
  deleted the query request parameter limit
  request-parameter-removed
- ●
  deleted the query request parameter name
  request-parameter-removed
- ●
  deleted the query request parameter offset
  request-parameter-removed
- ●
  deleted the query request parameter sortDir
  request-parameter-removed
- ●
  deleted the query request parameter sortKey
  request-parameter-removed
- ●
  deleted the query request parameter status
  request-parameter-removed
- ●
  deleted the query request parameter storageType
  request-parameter-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