Download OpenAPI specification:Download
Volumez orchestrator API
capacity | boolean |
authorization | string |
[- {
- "name": "string",
- "volumeid": "string",
- "type": "file",
- "contentvolume": "string",
- "contentsnapshot": "string",
- "size": 1,
- "maxsize": 0,
- "policy": "string",
- "consistencygroup": "string",
- "node": "string",
- "zone": "string",
- "zonereplica": "string",
- "volumegroupname": "string",
- "volumegroupid": "string",
- "replicationnode": "string",
- "replicationvolumegroupname": "string",
- "replicationvolumegroupid": "string",
- "volumerecoveryjob": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string",
- "throttlingscheme": "string",
- "allowdatamovement": false,
- "flavor": "regular"
}
]
authorization | string |
A Volume object
name required | string (Volume name) non-empty |
volumeid | string (Volume ID) non-empty |
type required | string Enum: "file" "block" |
contentvolume | string |
contentsnapshot | string |
size required | integer (Size, GiB) [ 1 .. 65536 ] |
maxsize | integer (Upper limit size, GiB) |
policy required | string non-empty |
consistencygroup | string |
node | string |
zone | string non-empty |
zonereplica | string |
volumegroupname | string (Volume Group name) non-empty |
volumegroupid | string (Volume ID) non-empty |
replicationnode | string |
replicationvolumegroupname | string (Replication Volume Group name) non-empty |
replicationvolumegroupid | string (Replication Volume ID) non-empty |
volumerecoveryjob | string (Volume Recovery Job ID) non-empty |
state | string |
status | string |
progress | integer |
capacitygroup | string (Capacity group from which the volume is allocated) non-empty |
throttlingscheme | string (Throttling Scheme for the volume) non-empty |
allowdatamovement | boolean (Allow movement of the volume) Default: false |
flavor | string Enum: "regular" "filedirect" |
{- "name": "string",
- "volumeid": "string",
- "type": "file",
- "contentvolume": "string",
- "contentsnapshot": "string",
- "size": 1,
- "maxsize": 0,
- "policy": "string",
- "consistencygroup": "string",
- "node": "string",
- "zone": "string",
- "zonereplica": "string",
- "volumegroupname": "string",
- "volumegroupid": "string",
- "replicationnode": "string",
- "replicationvolumegroupname": "string",
- "replicationvolumegroupid": "string",
- "volumerecoveryjob": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string",
- "throttlingscheme": "string",
- "allowdatamovement": false,
- "flavor": "regular"
}
{- "Message": "string"
}
volume required | string |
authorization | string |
{- "name": "string",
- "volumeid": "string",
- "type": "file",
- "contentvolume": "string",
- "contentsnapshot": "string",
- "size": 1,
- "maxsize": 0,
- "policy": "string",
- "consistencygroup": "string",
- "node": "string",
- "zone": "string",
- "zonereplica": "string",
- "volumegroupname": "string",
- "volumegroupid": "string",
- "replicationnode": "string",
- "replicationvolumegroupname": "string",
- "replicationvolumegroupid": "string",
- "volumerecoveryjob": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string",
- "throttlingscheme": "string",
- "allowdatamovement": false,
- "flavor": "regular"
}
volume required | string |
authorization | string |
A Volume object
name required | string (Volume name) non-empty |
volumeid | string (Volume ID) non-empty |
type required | string Enum: "file" "block" |
contentvolume | string |
contentsnapshot | string |
size required | integer (Size, GiB) [ 1 .. 65536 ] |
maxsize | integer (Upper limit size, GiB) |
policy required | string non-empty |
consistencygroup | string |
node | string |
zone | string non-empty |
zonereplica | string |
volumegroupname | string (Volume Group name) non-empty |
volumegroupid | string (Volume ID) non-empty |
replicationnode | string |
replicationvolumegroupname | string (Replication Volume Group name) non-empty |
replicationvolumegroupid | string (Replication Volume ID) non-empty |
volumerecoveryjob | string (Volume Recovery Job ID) non-empty |
state | string |
status | string |
progress | integer |
capacitygroup | string (Capacity group from which the volume is allocated) non-empty |
throttlingscheme | string (Throttling Scheme for the volume) non-empty |
allowdatamovement | boolean (Allow movement of the volume) Default: false |
flavor | string Enum: "regular" "filedirect" |
{- "name": "string",
- "volumeid": "string",
- "type": "file",
- "contentvolume": "string",
- "contentsnapshot": "string",
- "size": 1,
- "maxsize": 0,
- "policy": "string",
- "consistencygroup": "string",
- "node": "string",
- "zone": "string",
- "zonereplica": "string",
- "volumegroupname": "string",
- "volumegroupid": "string",
- "replicationnode": "string",
- "replicationvolumegroupname": "string",
- "replicationvolumegroupid": "string",
- "volumerecoveryjob": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string",
- "throttlingscheme": "string",
- "allowdatamovement": false,
- "flavor": "regular"
}
{- "Message": "string"
}
volume required | string |
authorization | string |
{- "Volumegroupname": "string",
- "encryption": true,
- "Integrity": true,
- "allocation": "string",
- "compression": true,
- "deduplication": true,
- "writecache": true,
- "redundancy": 0,
- "size": 0,
- "targetsecret": "string",
- "allocatedsize": 0,
- "resiliency": "string",
- "raidcolumns": 0,
- "mediasize": 0,
- "mediabandwidthwrite": 0,
- "mediabandwidthread": 0,
- "mediaiopswrite": 0,
- "mediaiopsread": 0,
- "media": [
- "string"
], - "cachesize": 0,
- "cacheresiliency": "string",
- "cacheredundancy": 0,
- "cacheraidcolumns": 0,
- "cachemediasize": 0,
- "cachemediabandwidthwrite": 0,
- "cachemediabandwidthread": 0,
- "cachemediaiopswrite": 0,
- "cachemediaiopsread": 0,
- "cachemedia": [
- "string"
], - "attachments": [
- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
}
authorization | string |
Auto Provision Volume object
required | object (Volume) |
object (AutoProvisionInfraPlan) | |
cloudProvider required | string (cloud provider name) non-empty |
accountId required | string (the customers provider account id) non-empty |
sshKeyName | string (ssh key name) non-empty |
imageId | string (os image id) non-empty |
region required | string (Region to create teh volume in) non-empty |
availabilityZones required | Array of strings non-empty |
subnets required | Array of strings non-empty |
osType required | string Enum: "Linux" "Rhel" "Ubuntu" |
{- "volume": {
- "name": "string",
- "volumeid": "string",
- "type": "file",
- "contentvolume": "string",
- "contentsnapshot": "string",
- "size": 1,
- "maxsize": 0,
- "policy": "string",
- "consistencygroup": "string",
- "node": "string",
- "zone": "string",
- "zonereplica": "string",
- "volumegroupname": "string",
- "volumegroupid": "string",
- "replicationnode": "string",
- "replicationvolumegroupname": "string",
- "replicationvolumegroupid": "string",
- "volumerecoveryjob": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string",
- "throttlingscheme": "string",
- "allowdatamovement": false,
- "flavor": "regular"
}, - "infraPlan": {
- "instanceType": "string",
- "instanceCount": 1,
- "availabilityZones": [
- "string"
], - "osType": "Linux",
- "price": 1
}, - "cloudProvider": "string",
- "accountId": "string",
- "sshKeyName": "string",
- "imageId": "string",
- "region": "string",
- "availabilityZones": [
- "string"
], - "subnets": [
- "string"
], - "osType": "Linux"
}
{- "Message": "string"
}
authorization | string |
[- {
- "instanceid": "string",
- "name": "string",
- "os": "string",
- "osversion": "string",
- "kversion": "string",
- "controladdress": "string",
- "credential": "string",
- "accountID": "string",
- "region": "string",
- "zone": "string",
- "ResourceNamespace": "string",
- "PhysicalProximityGroup": "string",
- "ResiliencyDomain": "string",
- "FaultDomain": "string",
- "offlinetime": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "connectorversion": "string",
- "label": "string",
- "tags": { },
- "cloudprovider": "string",
- "nodecluster": "string",
- "autoprovisionInfraUUID": "string",
- "instancetype": "string"
}
]
node required | string Name of node to return |
authorization | string |
user defined tags
property name* additional property | string |
{- "property1": "string",
- "property2": "string"
}
{- "Message": "string"
}
node required | string Name of node to return |
authorization | string |
{- "instanceid": "string",
- "name": "string",
- "os": "string",
- "osversion": "string",
- "kversion": "string",
- "controladdress": "string",
- "credential": "string",
- "accountID": "string",
- "region": "string",
- "zone": "string",
- "ResourceNamespace": "string",
- "PhysicalProximityGroup": "string",
- "ResiliencyDomain": "string",
- "FaultDomain": "string",
- "offlinetime": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "connectorversion": "string",
- "label": "string",
- "tags": { },
- "cloudprovider": "string",
- "nodecluster": "string",
- "autoprovisionInfraUUID": "string",
- "instancetype": "string"
}
node required | string Name of node to upgrade |
authorization | string |
Connector Version
version | string |
{- "version": "string"
}
{- "Message": "string"
}
Policies allow you to declare the desired characteristics of volumes you will later create. Policies are expressed in terms of outcomes (such as desired performance and resiliency). When you later ask Volumez to create volumes using a policy, it will automatically allocate and configure whatever is necessary to match these desired outcomes.
authorization | string |
[- {
- "name": "string",
- "iopswrite": 0,
- "iopsread": 0,
- "bandwidthwrite": 0,
- "bandwidthread": 0,
- "latencywrite": 0,
- "latencyread": 0,
- "latencyreadcold": 0,
- "colddata": 100,
- "localzoneread": true,
- "failureperformance": true,
- "capacityoptimization": "capacity",
- "capacityreservation": 500,
- "resiliencymedia": 2,
- "resiliencynode": 2,
- "resiliencyzone": 0,
- "resiliencyregion": 1,
- "replicationrpo": 3600,
- "replicationbandwidth": 0,
- "encryption": true,
- "sed": true,
- "integrity": true,
- "snapshotkeep": 0,
- "snapshotfrequency": "string",
- "snapshotday": 0,
- "snapshothour": 0,
- "snapshotminute": 0,
- "createdbyuserName": "string",
- "createdbyuseremail": "string",
- "createdtime": "string",
- "updatebyusername": "string",
- "updatebyUseremail": "string",
- "updatetime": "string"
}
]
authorization | string |
A Policy object
name required | string non-empty A name for the policy. The name can be any non-empty string that does not contain a white space. |
iopswrite | integer >= 0 Enter the maximum write IOPS that a volume is expected to sustain (assuming 8K writes). Write IOPS should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
iopsread | integer >= 0 Enter the maximum read IOPS that a volume is expected to sustain (assuming 8K reads). Read IOPS should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
bandwidthwrite | integer >= 0 Enter the maximum write bandwidth that a volume is expected to sustain. Write Bandwidth should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
bandwidthread | integer >= 0 Enter the maximum read bandwidth that a volume is expected to sustain. Read Bandwidth should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
latencywrite | integer >= 0 Enter the maximum latency that a volume is expected to sustain. Write latency should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
latencyread | integer >= 0 Enter the maximum read IOPS that a volume is expected to sustain. Read latency should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
latencyreadcold | integer >= 0 If not all the reads are hot (i.e., Percentage of Cold Reads is >0) – Enter the more relaxed constraints for read latencies of cold data. Valid values: non-negative integer number, that is larger than “Read Latency”. |
colddata | integer [ 0 .. 100 ] Enter the percentage of the volume’s capacity that is expected to be “cold” (i.e. expected to only have infrequent reads). Default is 0%. Values that are greater than 0 give Volumez the option to use more economic media with more relaxed read performance requirements. Valid values: Integers in the range of 0..100. |
localzoneread | boolean Setting this value to “Yes” directs Volumez to prefer volume configurations where reads are usually happening from disks that are in the same zone as the application. This saves east-west network traffic across zones, however more media per zone will be required to achieve read-IOPs requirements. Set this value to “Yes” if you have network constraints (bandwidth or cost) across your zones; otherwise set it to “No”. |
failureperformance | boolean Setting this value to “Yes” directs Volumez to over-provision volumes in a way that even after having a failure, the volumes will have the desired performance. Setting this value to “No” directs Volumez to provision volumes according to the desired performance, however in a case of failure – performance may be impacted. The default value is “No”. |
capacityoptimization required | string Enum: "capacity" "balanced" "performance" Choosing “Capacity” directs Volumez to prefer using capacity-saving methods (such as compression, deduplication, erasure coding and thin provisioning) where relevant, in order to consume the minimum amount of raw media. Using such methods might take some CPU cycles, and might reduce the performance of your volumes (it will still be within the range you specified). Choosing “Balanced” directs Volumez to prefer using some capacity-saving methods where relevant, in order to use less raw media, while consuming a small amount of CPU cycles. “Performance Optimized” directs Volumez to avoid using capacity-saving any methods (such as compression and deduplication) that reduce media consumption. This way applications can get the optimal performance from their media, however more raw media might be consumed to provision Performance-Optimized volumes. |
capacityreservation | integer [ 0 .. 500 ] Enter how much logical capacity is reserved up-front for the applications to use. If more capacity is needed for the volume, it will be allocated based on availability of media. Capacities that are reserved can be used for the volume itself and for its snapshots. For example – Use 0% for thin-provisioned volumes, 130% for thick-provisioned volumes with estimated 30% of space for snapshots. Valid values are 0%-500%, default is 20%. |
resiliencymedia | integer [ 0 .. 2 ] Enter how many media failures (e.g. disk, memory card) the system is required to sustain, and still serve volumes of this policy. A value of “0” means any disk failure will result data unavailability and loss. Valid values are 0..3, default value is 2. |
resiliencynode | integer [ 0 .. 2 ] Enter how many Volumez node (e.g. EC2 instance, server) failures the system is required to sustain, and still serve volumes of this policy. This is different than “Media failures” because sometimes multiple media copies may end on a single node. A value of “0” means any node failure will result data unavailability and loss. Valid values are 0..3, default value is 1. |
resiliencyzone | integer >= 0 Enter how many zones (e.g. AWS availability zones, DataCenters Buildings) failures the system is required to sustain, and still serve volumes of this policy. Note: zones are assumed to be within the same metro distance, and resiliency to zone failures means cross-zone network traffic. Valid values are 0..2, default value is 1. |
resiliencyregion | integer [ 0 .. 1 ] Enter how many regions (e.g. AWS regions zones, DataCenters across continents) failures the system is required to sustain, and still serve volumes of this policy. Note: regions are assumed to reside across WAN distance, with some bandwidth limitations. Valid values are 0 and 1, default value is 0. |
replicationrpo | integer [ 0 .. 3600 ] Enter how many seconds are allowed for the replica to stay behind the primary storage. 0 means synchronous replication. Valid values are 0..3600, default value is 0. Max value: 3600. (1 hour). |
replicationbandwidth | integer Specifies the maximum bandwidth that Volumez is allowed to consume for replication of this volume (MB/s). 0 means no bandwidth limitation. |
encryption | boolean Enter “YES” to encrypt the data in server where the application is running. Note: No change is needed in the applications themselves, however encryption will consume some CPU cycles on the application server. Default value NO. |
sed | boolean Enter “YES” to direct Volumez to only use media with disk encryption capabilities. Note that specifying “NO” can still use such media, however it is not a must to use it. Default value: NO. |
integrity | boolean Enter “YES” to direct Volumez to activate the “Device Mapper integrity” protection for the volume. This capability provides strong integrity checking. Note: No change is needed in the applications themselves, however Data Integrity will consume non-negligible CPU cycles on the application server. Default value: NO. |
snapshotkeep | integer |
snapshotfrequency | string |
snapshotday | integer |
snapshothour | integer |
snapshotminute | integer |
createdbyuserName | string |
createdbyuseremail | string |
createdtime | string |
updatebyusername | string |
updatebyUseremail | string |
updatetime | string |
{- "name": "string",
- "iopswrite": 0,
- "iopsread": 0,
- "bandwidthwrite": 0,
- "bandwidthread": 0,
- "latencywrite": 0,
- "latencyread": 0,
- "latencyreadcold": 0,
- "colddata": 100,
- "localzoneread": true,
- "failureperformance": true,
- "capacityoptimization": "capacity",
- "capacityreservation": 500,
- "resiliencymedia": 2,
- "resiliencynode": 2,
- "resiliencyzone": 0,
- "resiliencyregion": 1,
- "replicationrpo": 3600,
- "replicationbandwidth": 0,
- "encryption": true,
- "sed": true,
- "integrity": true,
- "snapshotkeep": 0,
- "snapshotfrequency": "string",
- "snapshotday": 0,
- "snapshothour": 0,
- "snapshotminute": 0,
- "createdbyuserName": "string",
- "createdbyuseremail": "string",
- "createdtime": "string",
- "updatebyusername": "string",
- "updatebyUseremail": "string",
- "updatetime": "string"
}
{- "Message": "string"
}
policy required | string |
authorization | string |
{- "name": "string",
- "iopswrite": 0,
- "iopsread": 0,
- "bandwidthwrite": 0,
- "bandwidthread": 0,
- "latencywrite": 0,
- "latencyread": 0,
- "latencyreadcold": 0,
- "colddata": 100,
- "localzoneread": true,
- "failureperformance": true,
- "capacityoptimization": "capacity",
- "capacityreservation": 500,
- "resiliencymedia": 2,
- "resiliencynode": 2,
- "resiliencyzone": 0,
- "resiliencyregion": 1,
- "replicationrpo": 3600,
- "replicationbandwidth": 0,
- "encryption": true,
- "sed": true,
- "integrity": true,
- "snapshotkeep": 0,
- "snapshotfrequency": "string",
- "snapshotday": 0,
- "snapshothour": 0,
- "snapshotminute": 0,
- "createdbyuserName": "string",
- "createdbyuseremail": "string",
- "createdtime": "string",
- "updatebyusername": "string",
- "updatebyUseremail": "string",
- "updatetime": "string"
}
policy required | string |
authorization | string |
A Policy object
name required | string non-empty A name for the policy. The name can be any non-empty string that does not contain a white space. |
iopswrite | integer >= 0 Enter the maximum write IOPS that a volume is expected to sustain (assuming 8K writes). Write IOPS should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
iopsread | integer >= 0 Enter the maximum read IOPS that a volume is expected to sustain (assuming 8K reads). Read IOPS should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
bandwidthwrite | integer >= 0 Enter the maximum write bandwidth that a volume is expected to sustain. Write Bandwidth should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
bandwidthread | integer >= 0 Enter the maximum read bandwidth that a volume is expected to sustain. Read Bandwidth should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
latencywrite | integer >= 0 Enter the maximum latency that a volume is expected to sustain. Write latency should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
latencyread | integer >= 0 Enter the maximum read IOPS that a volume is expected to sustain. Read latency should be a positive integer number. Volumez will guarantee to provide this performance, regardless of the volume size or other volumes. |
latencyreadcold | integer >= 0 If not all the reads are hot (i.e., Percentage of Cold Reads is >0) – Enter the more relaxed constraints for read latencies of cold data. Valid values: non-negative integer number, that is larger than “Read Latency”. |
colddata | integer [ 0 .. 100 ] Enter the percentage of the volume’s capacity that is expected to be “cold” (i.e. expected to only have infrequent reads). Default is 0%. Values that are greater than 0 give Volumez the option to use more economic media with more relaxed read performance requirements. Valid values: Integers in the range of 0..100. |
localzoneread | boolean Setting this value to “Yes” directs Volumez to prefer volume configurations where reads are usually happening from disks that are in the same zone as the application. This saves east-west network traffic across zones, however more media per zone will be required to achieve read-IOPs requirements. Set this value to “Yes” if you have network constraints (bandwidth or cost) across your zones; otherwise set it to “No”. |
failureperformance | boolean Setting this value to “Yes” directs Volumez to over-provision volumes in a way that even after having a failure, the volumes will have the desired performance. Setting this value to “No” directs Volumez to provision volumes according to the desired performance, however in a case of failure – performance may be impacted. The default value is “No”. |
capacityoptimization required | string Enum: "capacity" "balanced" "performance" Choosing “Capacity” directs Volumez to prefer using capacity-saving methods (such as compression, deduplication, erasure coding and thin provisioning) where relevant, in order to consume the minimum amount of raw media. Using such methods might take some CPU cycles, and might reduce the performance of your volumes (it will still be within the range you specified). Choosing “Balanced” directs Volumez to prefer using some capacity-saving methods where relevant, in order to use less raw media, while consuming a small amount of CPU cycles. “Performance Optimized” directs Volumez to avoid using capacity-saving any methods (such as compression and deduplication) that reduce media consumption. This way applications can get the optimal performance from their media, however more raw media might be consumed to provision Performance-Optimized volumes. |
capacityreservation | integer [ 0 .. 500 ] Enter how much logical capacity is reserved up-front for the applications to use. If more capacity is needed for the volume, it will be allocated based on availability of media. Capacities that are reserved can be used for the volume itself and for its snapshots. For example – Use 0% for thin-provisioned volumes, 130% for thick-provisioned volumes with estimated 30% of space for snapshots. Valid values are 0%-500%, default is 20%. |
resiliencymedia | integer [ 0 .. 2 ] Enter how many media failures (e.g. disk, memory card) the system is required to sustain, and still serve volumes of this policy. A value of “0” means any disk failure will result data unavailability and loss. Valid values are 0..3, default value is 2. |
resiliencynode | integer [ 0 .. 2 ] Enter how many Volumez node (e.g. EC2 instance, server) failures the system is required to sustain, and still serve volumes of this policy. This is different than “Media failures” because sometimes multiple media copies may end on a single node. A value of “0” means any node failure will result data unavailability and loss. Valid values are 0..3, default value is 1. |
resiliencyzone | integer >= 0 Enter how many zones (e.g. AWS availability zones, DataCenters Buildings) failures the system is required to sustain, and still serve volumes of this policy. Note: zones are assumed to be within the same metro distance, and resiliency to zone failures means cross-zone network traffic. Valid values are 0..2, default value is 1. |
resiliencyregion | integer [ 0 .. 1 ] Enter how many regions (e.g. AWS regions zones, DataCenters across continents) failures the system is required to sustain, and still serve volumes of this policy. Note: regions are assumed to reside across WAN distance, with some bandwidth limitations. Valid values are 0 and 1, default value is 0. |
replicationrpo | integer [ 0 .. 3600 ] Enter how many seconds are allowed for the replica to stay behind the primary storage. 0 means synchronous replication. Valid values are 0..3600, default value is 0. Max value: 3600. (1 hour). |
replicationbandwidth | integer Specifies the maximum bandwidth that Volumez is allowed to consume for replication of this volume (MB/s). 0 means no bandwidth limitation. |
encryption | boolean Enter “YES” to encrypt the data in server where the application is running. Note: No change is needed in the applications themselves, however encryption will consume some CPU cycles on the application server. Default value NO. |
sed | boolean Enter “YES” to direct Volumez to only use media with disk encryption capabilities. Note that specifying “NO” can still use such media, however it is not a must to use it. Default value: NO. |
integrity | boolean Enter “YES” to direct Volumez to activate the “Device Mapper integrity” protection for the volume. This capability provides strong integrity checking. Note: No change is needed in the applications themselves, however Data Integrity will consume non-negligible CPU cycles on the application server. Default value: NO. |
snapshotkeep | integer |
snapshotfrequency | string |
snapshotday | integer |
snapshothour | integer |
snapshotminute | integer |
createdbyuserName | string |
createdbyuseremail | string |
createdtime | string |
updatebyusername | string |
updatebyUseremail | string |
updatetime | string |
{- "name": "string",
- "iopswrite": 0,
- "iopsread": 0,
- "bandwidthwrite": 0,
- "bandwidthread": 0,
- "latencywrite": 0,
- "latencyread": 0,
- "latencyreadcold": 0,
- "colddata": 100,
- "localzoneread": true,
- "failureperformance": true,
- "capacityoptimization": "capacity",
- "capacityreservation": 500,
- "resiliencymedia": 2,
- "resiliencynode": 2,
- "resiliencyzone": 0,
- "resiliencyregion": 1,
- "replicationrpo": 3600,
- "replicationbandwidth": 0,
- "encryption": true,
- "sed": true,
- "integrity": true,
- "snapshotkeep": 0,
- "snapshotfrequency": "string",
- "snapshotday": 0,
- "snapshothour": 0,
- "snapshotminute": 0,
- "createdbyuserName": "string",
- "createdbyuseremail": "string",
- "createdtime": "string",
- "updatebyusername": "string",
- "updatebyUseremail": "string",
- "updatetime": "string"
}
{- "Message": "string"
}
policy required | string |
authorization | string |
[- {
- "name": "string",
- "volumeid": "string",
- "type": "file",
- "contentvolume": "string",
- "contentsnapshot": "string",
- "size": 1,
- "maxsize": 0,
- "policy": "string",
- "consistencygroup": "string",
- "node": "string",
- "zone": "string",
- "zonereplica": "string",
- "volumegroupname": "string",
- "volumegroupid": "string",
- "replicationnode": "string",
- "replicationvolumegroupname": "string",
- "replicationvolumegroupid": "string",
- "volumerecoveryjob": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string",
- "throttlingscheme": "string",
- "allowdatamovement": false,
- "flavor": "regular"
}
]
policy required | string |
size required | integer |
zone required | string |
capacity_group | string |
authorization | string |
{- "volumegroup": {
- "Volumegroupname": "string",
- "encryption": true,
- "Integrity": true,
- "allocation": "string",
- "compression": true,
- "deduplication": true,
- "writecache": true,
- "redundancy": 0,
- "size": 0,
- "targetsecret": "string",
- "allocatedsize": 0,
- "resiliency": "string",
- "raidcolumns": 0,
- "mediasize": 0,
- "mediabandwidthwrite": 0,
- "mediabandwidthread": 0,
- "mediaiopswrite": 0,
- "mediaiopsread": 0,
- "media": [
- "string"
], - "cachesize": 0,
- "cacheresiliency": "string",
- "cacheredundancy": 0,
- "cacheraidcolumns": 0,
- "cachemediasize": 0,
- "cachemediabandwidthwrite": 0,
- "cachemediabandwidthread": 0,
- "cachemediaiopswrite": 0,
- "cachemediaiopsread": 0,
- "cachemedia": [
- "string"
], - "attachments": [
- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
}, - "replicationvolumegroup": {
- "Volumegroupname": "string",
- "encryption": true,
- "Integrity": true,
- "allocation": "string",
- "compression": true,
- "deduplication": true,
- "writecache": true,
- "redundancy": 0,
- "size": 0,
- "targetsecret": "string",
- "allocatedsize": 0,
- "resiliency": "string",
- "raidcolumns": 0,
- "mediasize": 0,
- "mediabandwidthwrite": 0,
- "mediabandwidthread": 0,
- "mediaiopswrite": 0,
- "mediaiopsread": 0,
- "media": [
- "string"
], - "cachesize": 0,
- "cacheresiliency": "string",
- "cacheredundancy": 0,
- "cacheraidcolumns": 0,
- "cachemediasize": 0,
- "cachemediabandwidthwrite": 0,
- "cachemediabandwidthread": 0,
- "cachemediaiopswrite": 0,
- "cachemediaiopsread": 0,
- "cachemedia": [
- "string"
], - "attachments": [
- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
}
}
authorization | string |
A Network object
name required | string non-empty |
zone | string non-empty |
type required | string Enum: "management" "storage" |
ipstart required | string^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(2... |
ipend required | string^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(2... |
{- "name": "string",
- "zone": "string",
- "type": "management",
- "ipstart": "string",
- "ipend": "string"
}
{- "Message": "string"
}
network required | string |
authorization | string |
{- "name": "string",
- "zone": "string",
- "type": "management",
- "ipstart": "string",
- "ipend": "string"
}
network required | string |
authorization | string |
A Network object
name required | string non-empty |
zone | string non-empty |
type required | string Enum: "management" "storage" |
ipstart required | string^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(2... |
ipend required | string^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(2... |
{- "name": "string",
- "zone": "string",
- "type": "management",
- "ipstart": "string",
- "ipend": "string"
}
{- "Message": "string"
}
internal | boolean |
page | integer |
count | integer |
authorization | string |
[- {
- "id": 0,
- "type": "string",
- "object": "string",
- "args": { },
- "state": "string",
- "status": "string",
- "progress": 0,
- "starttime": "string",
- "endtime": "string",
- "username": "string",
- "useremail": "string"
}
]
job required | integer |
authorization | string |
{- "id": 0,
- "type": "string",
- "object": "string",
- "args": { },
- "state": "string",
- "status": "string",
- "progress": 0,
- "starttime": "string",
- "endtime": "string",
- "username": "string",
- "useremail": "string"
}
authorization | string |
A Snapshot object
name | string |
consistency | string Enum: "crash" "application" |
group_name | string |
volumes | Array of strings |
{- "name": "string",
- "consistency": "crash",
- "group_name": "string",
- "volumes": [
- "string"
]
}
{- "Message": "string"
}
snapshot_group_name required | string |
authorization | string |
[- {
- "volumename": "string",
- "volumeid": "string",
- "volumesize": 0,
- "name": "string",
- "snapshotid": "string",
- "targetsecret": "string",
- "consistency": "crash",
- "time": "string",
- "policy": true,
- "consistencygroup": true,
- "consistencygroupname": "string",
- "used": 0,
- "state": "string",
- "status": "string",
- "progress": 0,
- "numberofattachments": 0
}
]
volume required | string |
authorization | string |
[- {
- "volumename": "string",
- "volumeid": "string",
- "volumesize": 0,
- "name": "string",
- "snapshotid": "string",
- "targetsecret": "string",
- "consistency": "crash",
- "time": "string",
- "policy": true,
- "consistencygroup": true,
- "consistencygroupname": "string",
- "used": 0,
- "state": "string",
- "status": "string",
- "progress": 0,
- "numberofattachments": 0
}
]
volume required | string |
authorization | string |
A Snapshot object
volumename | string (Volume name) |
volumeid | string (Volume ID) non-empty |
volumesize | integer |
name required | string (Snapshot name) non-empty |
snapshotid | string (Snapshot ID) non-empty |
targetsecret | string (Target connect secret) non-empty |
consistency required | string Enum: "crash" "application" |
time | string |
policy | boolean |
consistencygroup | boolean |
consistencygroupname | string |
used | integer |
state | string |
status | string |
progress | integer |
numberofattachments | integer |
{- "volumename": "string",
- "volumeid": "string",
- "volumesize": 0,
- "name": "string",
- "snapshotid": "string",
- "targetsecret": "string",
- "consistency": "crash",
- "time": "string",
- "policy": true,
- "consistencygroup": true,
- "consistencygroupname": "string",
- "used": 0,
- "state": "string",
- "status": "string",
- "progress": 0,
- "numberofattachments": 0
}
{- "Message": "string"
}
volume required | string |
snapshot required | string |
authorization | string |
{- "volumename": "string",
- "volumeid": "string",
- "volumesize": 0,
- "name": "string",
- "snapshotid": "string",
- "targetsecret": "string",
- "consistency": "crash",
- "time": "string",
- "policy": true,
- "consistencygroup": true,
- "consistencygroupname": "string",
- "used": 0,
- "state": "string",
- "status": "string",
- "progress": 0,
- "numberofattachments": 0
}
volume required | string |
snapshot required | string |
authorization | string |
A Snapshot object
volumename | string (Volume name) |
volumeid | string (Volume ID) non-empty |
volumesize | integer |
name required | string (Snapshot name) non-empty |
snapshotid | string (Snapshot ID) non-empty |
targetsecret | string (Target connect secret) non-empty |
consistency required | string Enum: "crash" "application" |
time | string |
policy | boolean |
consistencygroup | boolean |
consistencygroupname | string |
used | integer |
state | string |
status | string |
progress | integer |
numberofattachments | integer |
{- "volumename": "string",
- "volumeid": "string",
- "volumesize": 0,
- "name": "string",
- "snapshotid": "string",
- "targetsecret": "string",
- "consistency": "crash",
- "time": "string",
- "policy": true,
- "consistencygroup": true,
- "consistencygroupname": "string",
- "used": 0,
- "state": "string",
- "status": "string",
- "progress": 0,
- "numberofattachments": 0
}
{- "Message": "string"
}
capacity | boolean |
authorization | string |
[- {
- "volumename": "string",
- "volumeid": "string",
- "volumesize": 0,
- "name": "string",
- "snapshotid": "string",
- "targetsecret": "string",
- "consistency": "crash",
- "time": "string",
- "policy": true,
- "consistencygroup": true,
- "consistencygroupname": "string",
- "used": 0,
- "state": "string",
- "status": "string",
- "progress": 0,
- "numberofattachments": 0
}
]
authorization | string |
[- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
volume required | string |
authorization | string |
[- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
volume required | string |
snapshot required | string |
authorization | string |
[- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
volume required | string |
snapshot required | string |
authorization | string |
An Attachment object
volumename | string (Volume name) |
volumeid | string (Volume ID) |
snapshotname | string (Snapshot Name) |
snapshotid | string (Snapshot ID) |
node required | string |
state | string |
status | string |
progress | integer |
mountpoint | string (Mount point) |
readonly | boolean (Read Only) |
allocated_resources | integer (Allocated performance resources) [ 1 .. 100 ] |
{- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
{- "Message": "string"
}
volume required | string |
snapshot required | string |
node required | string |
authorization | string |
{- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
volume required | string |
snapshot required | string |
node required | string |
force | boolean Default: false |
authorization | string |
{- "Message": "string"
}
volume required | string |
snapshot required | string |
node required | string |
authorization | string |
An Attachment object
volumename | string (Volume name) |
volumeid | string (Volume ID) |
snapshotname | string (Snapshot Name) |
snapshotid | string (Snapshot ID) |
node required | string |
state | string |
status | string |
progress | integer |
mountpoint | string (Mount point) |
readonly | boolean (Read Only) |
allocated_resources | integer (Allocated performance resources) [ 1 .. 100 ] |
{- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
{- "Message": "string"
}
authorization | string |
[- {
- "mediaid": "string",
- "size": 0,
- "model": "string",
- "media": "string",
- "bus": "string",
- "location": "string",
- "sed": true,
- "node": "string",
- "cloudprovider": "string",
- "accountID": "string",
- "region": "string",
- "zone": "string",
- "ResourceNamespace": "string",
- "PhysicalProximityGroup": "string",
- "ResiliencyDomain": "string",
- "FaultDomain": "string",
- "firmware": "string",
- "sectorsize": 0,
- "iopsread": 0,
- "iopswrite": 0,
- "bandwidthread": 0,
- "bandwidthwrite": 0,
- "BandwidthReserved": 0,
- "latencyread": 0,
- "latencywrite": 0,
- "offlinetime": "string",
- "freesize": 0,
- "freeiopsread": 0,
- "freeiopswrite": 0,
- "freebandwidthread": 0,
- "freebandwidthwrite": 0,
- "volumescount": 0,
- "assignment": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string"
}
]
media required | string |
authorization | string |
capacity_group | string |
reprofile | boolean Profile media even if it was already profiled |
{- "capacity_group": "string",
- "reprofile": true
}
{- "Message": "string"
}
media required | string |
authorization | string |
A Media Profile object
iopsread | integer |
iopswrite | integer |
bandwidthread | integer |
bandwidthwrite | integer |
latencyread | integer |
latencywrite | integer |
freeiopsread | integer |
freeiopswrite | integer |
freebandwidthread | integer |
freebandwidthwrite | integer |
{- "iopsread": 0,
- "iopswrite": 0,
- "bandwidthread": 0,
- "bandwidthwrite": 0,
- "latencyread": 0,
- "latencywrite": 0,
- "freeiopsread": 0,
- "freeiopswrite": 0,
- "freebandwidthread": 0,
- "freebandwidthwrite": 0
}
{- "Message": "string"
}
startfrom | string |
count | integer |
authorization | string |
[- {
- "media": {
- "mediaid": "string",
- "size": 0,
- "model": "string",
- "media": "string",
- "bus": "string",
- "location": "string",
- "sed": true,
- "node": "string",
- "cloudprovider": "string",
- "accountID": "string",
- "region": "string",
- "zone": "string",
- "ResourceNamespace": "string",
- "PhysicalProximityGroup": "string",
- "ResiliencyDomain": "string",
- "FaultDomain": "string",
- "firmware": "string",
- "sectorsize": 0,
- "iopsread": 0,
- "iopswrite": 0,
- "bandwidthread": 0,
- "bandwidthwrite": 0,
- "BandwidthReserved": 0,
- "latencyread": 0,
- "latencywrite": 0,
- "offlinetime": "string",
- "freesize": 0,
- "freeiopsread": 0,
- "freeiopswrite": 0,
- "freebandwidthread": 0,
- "freebandwidthwrite": 0,
- "volumescount": 0,
- "assignment": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "capacitygroup": "string"
}, - "flavor": "stripped",
- "members": [
- "string"
]
}
]
authorization | string |
Virtual media creation parameters
selector | string non-empty |
flavor | string Enum: "stripped" "raid1" "split" |
{- "selector": "string",
- "flavor": "stripped"
}
{- "Message": "string",
- "JobID": "string",
- "ObjectID": "string"
}
authorization | string |
[- {
- "name": "string",
- "zones1": "string",
- "systemtypes1": "string",
- "zones2": "string",
- "systemtypes2": "string",
- "mediaprotocol": "string",
- "replicationprotocol": "string",
- "replicationbandwidth": 0
}
]
authorization | string |
A Connectivity object
name required | string |
zones1 required | string |
systemtypes1 required | string^(?:(?:rhel|sles|amzn|ubuntu)[, ])*(?:rhel|sl... |
zones2 required | string |
systemtypes2 required | string^(?:(?:rhel|sles|amzn|ubuntu)[, ])*(?:rhel|sl... |
mediaprotocol required | string |
replicationprotocol required | string |
replicationbandwidth | integer >= 0 |
{- "name": "string",
- "zones1": "string",
- "systemtypes1": "string",
- "zones2": "string",
- "systemtypes2": "string",
- "mediaprotocol": "string",
- "replicationprotocol": "string",
- "replicationbandwidth": 0
}
{- "Message": "string"
}
connectivity required | string |
authorization | string |
{- "name": "string",
- "zones1": "string",
- "systemtypes1": "string",
- "zones2": "string",
- "systemtypes2": "string",
- "mediaprotocol": "string",
- "replicationprotocol": "string",
- "replicationbandwidth": 0
}
connectivity required | string |
authorization | string |
A Connectivity object
name required | string |
zones1 required | string |
systemtypes1 required | string^(?:(?:rhel|sles|amzn|ubuntu)[, ])*(?:rhel|sl... |
zones2 required | string |
systemtypes2 required | string^(?:(?:rhel|sles|amzn|ubuntu)[, ])*(?:rhel|sl... |
mediaprotocol required | string |
replicationprotocol required | string |
replicationbandwidth | integer >= 0 |
{- "name": "string",
- "zones1": "string",
- "systemtypes1": "string",
- "zones2": "string",
- "systemtypes2": "string",
- "mediaprotocol": "string",
- "replicationprotocol": "string",
- "replicationbandwidth": 0
}
{- "Message": "string"
}
capacity | boolean |
authorization | string |
[- {
- "alertid": "string",
- "type": "StateChange",
- "state": "Active",
- "severity": "Info",
- "objecttype": "Media",
- "objectid": "string",
- "creationtime": "string",
- "lastsendtime": "string",
- "cleartime": "string",
- "details": "string"
}
]
verbose | boolean Default: true if true will return the volume plan if false will omit the plan from the response |
authorization | string |
Array of objects non-empty | |
CapacityGroup | string capacity groups to create the volume from (optional) |
DefaultZone | string zone parameter for all volumes that dont have zone parameter |
DefaultPolicy | string policy parameter for all volumes that dont have policy parameter defined in their input |
{- "Volumes": [
- {
- "Policy": "string",
- "Size": 10,
- "Zone": "us-east-1a"
}
], - "CapacityGroup": "string",
- "DefaultZone": "string",
- "DefaultPolicy": "string"
}
{- "Message": "string",
- "Success": true,
- "Plans": [
- {
- "volumegroup": {
- "Volumegroupname": "string",
- "encryption": true,
- "Integrity": true,
- "allocation": "string",
- "compression": true,
- "deduplication": true,
- "writecache": true,
- "redundancy": 0,
- "size": 0,
- "targetsecret": "string",
- "allocatedsize": 0,
- "resiliency": "string",
- "raidcolumns": 0,
- "mediasize": 0,
- "mediabandwidthwrite": 0,
- "mediabandwidthread": 0,
- "mediaiopswrite": 0,
- "mediaiopsread": 0,
- "media": [
- "string"
], - "cachesize": 0,
- "cacheresiliency": "string",
- "cacheredundancy": 0,
- "cacheraidcolumns": 0,
- "cachemediasize": 0,
- "cachemediabandwidthwrite": 0,
- "cachemediabandwidthread": 0,
- "cachemediaiopswrite": 0,
- "cachemediaiopsread": 0,
- "cachemedia": [
- "string"
], - "attachments": [
- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
}, - "replicationvolumegroup": {
- "Volumegroupname": "string",
- "encryption": true,
- "Integrity": true,
- "allocation": "string",
- "compression": true,
- "deduplication": true,
- "writecache": true,
- "redundancy": 0,
- "size": 0,
- "targetsecret": "string",
- "allocatedsize": 0,
- "resiliency": "string",
- "raidcolumns": 0,
- "mediasize": 0,
- "mediabandwidthwrite": 0,
- "mediabandwidthread": 0,
- "mediaiopswrite": 0,
- "mediaiopsread": 0,
- "media": [
- "string"
], - "cachesize": 0,
- "cacheresiliency": "string",
- "cacheredundancy": 0,
- "cacheraidcolumns": 0,
- "cachemediasize": 0,
- "cachemediabandwidthwrite": 0,
- "cachemediabandwidthread": 0,
- "cachemediaiopswrite": 0,
- "cachemediaiopsread": 0,
- "cachemedia": [
- "string"
], - "attachments": [
- {
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "node": "string",
- "state": "string",
- "status": "string",
- "progress": 0,
- "mountpoint": "string",
- "readonly": true,
- "allocated_resources": 1
}
]
}
}
]
}
startfrom | string |
count | integer |
authorization | string |
[- {
- "name": "string",
- "id": "string",
- "volumename": "string",
- "volumeid": "string",
- "snapshotname": "string",
- "snapshotid": "string",
- "state": "string",
- "status": "string"
}
]
authorization | string |
An association object
name | string (name) |
volume | string (Volume) |
snapshot | string (Snapshot) non-empty |
mountpoint | string (Mount point) |
selector | string non-empty |
{- "name": "string",
- "volume": "string",
- "snapshot": "string",
- "mountpoint": "string",
- "selector": "string"
}
{- "Message": "string",
- "JobID": "string",
- "ObjectID": "string"
}
association required | string |
authorization | string |
An association object
name | string (name) |
snapshot | string (Snapshot) non-empty |
selector | string non-empty |
{- "name": "string",
- "snapshot": "string",
- "selector": "string"
}
{- "Message": "string"
}
A user object
email required | string non-empty |
password required | string >= 8 characters |
name required | string [ 1 .. 50 ] characters |
cloudprovider | string non-empty |
markettoken | string non-empty |
{- "email": "string",
- "password": "stringst",
- "name": "string",
- "cloudprovider": "string",
- "markettoken": "string"
}
{- "status": 0,
- "message": "string"
}
authorization | string |
{- "roles": [
- {
- "cloudProvider": {
- "type": "aws",
- "accountID": "string"
}, - "awsRole": {
- "arn": "string",
- "externalId": "string"
}, - "azureRole": {
- "activeDirectoryId": "string",
- "applicationId": "string",
- "secretId": "string"
}
}
]
}
authorization | string |
cloudProvider | string (CloudProviderType) Enum: "aws" "azure" |
object (CreateAwsRoleRequest) | |
object (CreateAzureRoleRequest) |
{- "cloudProvider": "aws",
- "awsRole": {
- "arn": "string",
- "externalId": "string"
}, - "azureRole": {
- "activeDirectoryId": "string",
- "applicationId": "string",
- "subscriptionId": "string",
- "secret": {
- "id": "string",
- "value": "string"
}
}
}
{ }
cloudProvider | string (CloudProviderType) Enum: "aws" "azure" Cloud provider type |
authorization | string |
{- "aws": [
- {
- "Region1": [
- "Zone1",
- "Zone2",
- "Zone3"
], - "Region2": [
- "Zone4",
- "Zone5"
]
}
], - "azure": {
- "property1": {
- "regionDisplayName": "string",
- "zones": [
- "string"
]
}, - "property2": {
- "regionDisplayName": "string",
- "zones": [
- "string"
]
}
}
}
cloudProviderAccountId required | string (CloudProviderAccountId) |
authorization | string |
cloudProvider | string (CloudProviderType) Enum: "aws" "azure" |
object (UpdateAwsRoleRequest) | |
object (UpdateAzureRoleRequest) |
{- "cloudProvider": "aws",
- "awsRole": {
- "arn": "string",
- "externalId": "string"
}, - "azureRole": {
- "applicationId": "string",
- "activeDirectoryId": "string",
- "secret": {
- "id": "string",
- "value": "string"
}
}
}
{- "Message": "string",
- "message": "string"
}
cloudProviderAccountId required | string (CloudProviderAccountId) |
authorization | string |
{- "Message": "string",
- "message": "string"
}
cloudProviderAccountId required | string (CloudProviderAccountId) |
authorization | string |
[- {
- "Zone1": [
- {
- "id": "VpcId1",
- "subnetId": "VpcSubnetId1"
}, - {
- "Id": "VpcId2",
- "SubnetId": "VpcSubnetId2"
}
], - "Zone2": {
- "id": "VpcId3",
- "subnetId": "VpcSubnetId3"
}
}
]
cloudProviderAccountId required | string (CloudProviderAccountId) |
region required | string (Region) |
nodeId required | string (NodeId) |
authorization | string |
{- "vpc": {
- "id": "string",
- "name": "string",
- "subnetId": "string",
- "subnetName": "string",
- "isDefault": true,
- "resourceGroup": "string"
}
}
cloudProviderAccountId required | string (CloudProviderAccountId) |
region required | string (Region) |
authorization | string |
[- {
- "Zone1": [
- {
- "id": "VpcId1",
- "subnetId": "VpcSubnetId1"
}, - {
- "Id": "VpcId2",
- "SubnetId": "VpcSubnetId2"
}
], - "Zone2": {
- "id": "VpcId3",
- "subnetId": "VpcSubnetId3"
}
}
]
shouldValidate | boolean Default: true validate the given resources |
authorization | string |
cloudProvider required | string (CloudProviderType) Enum: "aws" "azure" |
required | object |
osType | string (OSType) Enum: "ubuntu" "rhel" |
size required | integer <integer> |
region | string |
zones | Array of strings |
subnetIds | Array of strings |
accountId | string |
{- "cloudProvider": "aws",
- "policy": {
- "name": "string",
- "settings": {
- "iopsWrite": 0,
- "iopsRead": 0,
- "bandwidthWrite": 0,
- "bandwidthRead": 0,
- "latencyWrite": 0,
- "latencyRead": 0,
- "latencyReadCold": 0,
- "coldData": 100,
- "localZoneRead": true,
- "failurePerformance": true,
- "capacityOptimization": "capacity",
- "capacityReservation": 500,
- "resiliencyMedia": 2,
- "resiliencyNode": 2,
- "resiliencyZone": 0,
- "resiliencyRegion": 1,
- "replicationRpo": 3600,
- "replicationBandwidth": 0,
- "encryption": true,
- "sed": true,
- "integrity": true,
- "snapshotKeep": 0,
- "snapshotFrequency": "string",
- "snapshotDay": 0,
- "snapshotHour": 0,
- "snapshotMinute": 0
}
}, - "osType": "ubuntu",
- "size": 0,
- "region": "string",
- "zones": [
- "string"
], - "subnetIds": [
- "string"
], - "accountId": "string"
}
{- "instancesCount": 0,
- "instanceType": "string",
- "providerInstanceType": "string",
- "totalPrice": 0.1,
- "volumezPrice": 0.1,
- "mediaIOPSRead": 0,
- "mediaIOPSWrite": 0,
- "mediaBandwidthWrite": 0,
- "mediaBandwidthRead": 0,
- "raidResiliency": "string",
- "zones": [
- "string"
], - "subnetIds": [
- "string"
], - "osType": "ubuntu",
- "encryption": true,
- "mediaSize": 0,
- "raidColumns": 0,
- "redundancy": 0
}
cloudProvider required | string (CloudProviderType) Enum: "aws" "azure" |
required | object |
osType | string (OSType) Enum: "ubuntu" "rhel" |
size required | integer <integer> |
region | string |
zones | Array of strings |
subnetIds | Array of strings |
accountId | string |
{- "cloudProvider": "aws",
- "policy": {
- "name": "string",
- "settings": {
- "iopsWrite": 0,
- "iopsRead": 0,
- "bandwidthWrite": 0,
- "bandwidthRead": 0,
- "latencyWrite": 0,
- "latencyRead": 0,
- "latencyReadCold": 0,
- "coldData": 100,
- "localZoneRead": true,
- "failurePerformance": true,
- "capacityOptimization": "capacity",
- "capacityReservation": 500,
- "resiliencyMedia": 2,
- "resiliencyNode": 2,
- "resiliencyZone": 0,
- "resiliencyRegion": 1,
- "replicationRpo": 3600,
- "replicationBandwidth": 0,
- "encryption": true,
- "sed": true,
- "integrity": true,
- "snapshotKeep": 0,
- "snapshotFrequency": "string",
- "snapshotDay": 0,
- "snapshotHour": 0,
- "snapshotMinute": 0
}
}, - "osType": "ubuntu",
- "size": 0,
- "region": "string",
- "zones": [
- "string"
], - "subnetIds": [
- "string"
], - "accountId": "string"
}
{- "instancesCount": 0,
- "instanceType": "string",
- "providerInstanceType": "string",
- "totalPrice": 0.1,
- "volumezPrice": 0.1,
- "mediaIOPSRead": 0,
- "mediaIOPSWrite": 0,
- "mediaBandwidthWrite": 0,
- "mediaBandwidthRead": 0,
- "raidResiliency": "string",
- "zones": [
- "string"
], - "subnetIds": [
- "string"
], - "osType": "ubuntu",
- "encryption": true,
- "mediaSize": 0,
- "raidColumns": 0,
- "redundancy": 0
}
cloudProvider required | string (CloudProviderType) Enum: "aws" "azure" |
iops required | integer <integer> |
size required | integer <integer> |
throughput | integer <integer> |
{- "cloudProvider": "aws",
- "iops": 0,
- "size": 0,
- "throughput": 0
}
{- "totalPriceList": [
- {
- "storageType": "string",
- "volumeBasePrice": 0.1,
- "volumeTotalPrice": 0.1
}
]
}
A signin object
email required | string non-empty |
password required | string >= 8 characters |
{- "email": "string",
- "password": "stringst"
}
{- "AccessToken": "string",
- "IdToken": "string",
- "RefreshToken": "string",
- "ExpiresIn": 0,
- "TokenType": "string"
}
authorization | string |
new tenant's user
email required | string non-empty |
password required | string >= 8 characters |
name required | string [ 1 .. 50 ] characters |
tenantId required | string [ 1 .. 50 ] characters |
{- "email": "string",
- "password": "stringst",
- "name": "string",
- "tenantId": "string"
}
{- "Message": "string"
}
new user password
password | string |
name | string |
guid | string |
{- "password": "string",
- "name": "string",
- "guid": "string"
}
{- "Message": "string"
}
authorization | string |
new user password when logged in
oldpassword | string |
string | |
newpassword | string |
oldPassword | string |
newPassword | string |
{- "oldpassword": "string",
- "email": "string",
- "newpassword": "string",
- "oldPassword": "string",
- "newPassword": "string"
}
{- "Message": "string"
}
authorization | string |
New user attributes to add in Cognito
email required | string non-empty |
password required | string >= 8 characters |
name required | string [ 1 .. 50 ] characters |
{- "email": "string",
- "password": "stringst",
- "name": "string"
}
{- "Message": "string"
}
tenantId required | string Tenant Id to get all users for |
authorization | string |
[- {
- "Email": "string",
- "StatusCode": 0,
- "UserName": "string",
- "Name": "string",
- "CreatedDate": "string",
- "Enabled": true
}
]
authorization | string |
{- "pricing": {
- "priceUnit": 0.1
}, - "declarative": {
- "faultDomainCount": 1
}, - "throttle": {
- "selectedScheme": "string",
- "application": {
- "percentForSnapshots": 100
}, - "media": {
- "allowThrottleTargetSlices": true
}, - "attachment": {
- "defaultSnapshotResources": 0,
- "minReservedForTop": 0,
- "enableCagThrottling": true,
- "enableRaidThrottling": true,
- "enableSliceThrottling": true,
- "enableMultipathThrottling": true
}
}
}
authorization | string |
object |
{- "settingsToModify": {
- "declarative": {
- "faultDomainCount": 1
}, - "throttle": {
- "selectedScheme": "string",
- "application": {
- "percentForSnapshots": 100
}, - "media": {
- "allowThrottleTargetSlices": true
}, - "attachment": {
- "defaultSnapshotResources": 0,
- "minReservedForTop": 0,
- "enableCagThrottling": true,
- "enableRaidThrottling": true,
- "enableSliceThrottling": true,
- "enableMultipathThrottling": true
}
}
}
}
{ }
authorization | string |
required | object |
{- "settingsToReset": {
- "declarative": true,
- "throttle": true
}
}
{ }