Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-176940115.5 KB
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

OK

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"
      }
    }
  }
]