Read
GET v1/performance_policies
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsPerfPolicyName |
| full_name | NsPerfPolicyName |
| search_name | NsSearchName |
| description | NsDescription |
| block_size | NsUnsignedLong |
| compress | NsBoolean |
| cache | NsBoolean |
| cache_policy | NsCachePolicy |
| space_policy | NsSpacePolicy |
| app_category | NsString |
| dedupe_enabled | NsBoolean |
| deprecated | NsBoolean |
| predefined | NsBoolean |
| creation_time | NsTime |
| last_modified | NsTime |
GET v1/performance_policies/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsPerfPolicyName |
| full_name | NsPerfPolicyName |
| search_name | NsSearchName |
| description | NsDescription |
| block_size | NsUnsignedLong |
| compress | NsBoolean |
| cache | NsBoolean |
| cache_policy | NsCachePolicy |
| space_policy | NsSpacePolicy |
| app_category | NsString |
| dedupe_enabled | NsBoolean |
| deprecated | NsBoolean |
| predefined | NsBoolean |
| creation_time | NsTime |
| last_modified | NsTime |
Description
List all the performance policies.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Unique Identifier for the Performance Policy. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsPerfPolicyName | string | Name of the Performance Policy. String of up to 64 alphanumeric characters, - and . and : and space are allowed after first character. Example: 'SQL Server Logs'. | |
| full_name | NsPerfPolicyName | string | Fully qualified name of the Performance Policy. String of up to 64 alphanumeric characters, - and . and : and space are allowed after first character. Example: 'SQL Server Logs'. | |
| search_name | NsSearchName | string | Name of the Performance Policy used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| description | NsDescription | string | Description of a performance policy. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| block_size | NsUnsignedLong | number | Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created. Unsigned 64-bit integer. Example: 1234. | |
| compress | NsBoolean | boolean | Flag denoting if data in the associated volume should be compressed. Possible values: 'true', 'false'. | |
| cache | NsBoolean | boolean | Flag denoting if data in the associated volume should be cached. Possible values: 'true', 'false'. | |
| cache_policy | NsCachePolicy | string enum | Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality. Possible values: 'disabled', 'normal', 'aggressive', 'no_write', 'aggressive_read_no_write'. | |
| space_policy | NsSpacePolicy | string enum | Specifies the state of the volume upon space constraint violation such as volume limit violation, snapshot limit violation, volumes above their volume reserve or snapshot reserve if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'. Possible values: 'invalid', 'offline', 'non_writable', 'read_only', 'login_only'. | |
| app_category | NsString | string | Specifies the application category of the associated volume. Plain string. | |
| dedupe_enabled | NsBoolean | boolean | Specifies if dedupe is enabled for volumes created with this performance policy. Possible values: 'true', 'false'. | |
| deprecated | NsBoolean | boolean | Specifies if this performance policy is deprecated. Possible values: 'true', 'false'. | |
| predefined | NsBoolean | boolean | Specifies if this performance policy is predefined (read-only). Possible values: 'true', 'false'. | |
| creation_time | NsTime | number | Time when the performance policy was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when the performance policy's configurations were last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. |
JSON Response
{
"data" : {
"search_name" : "perfpolicy0.232298811272816",
"block_size" : 4096,
"name" : "perfpolicy0.232298811272816",
"last_modified" : 1426776087,
"full_name" : "perfpolicy0.232298811272816",
"description" : "wd183vmzeaIUKk7JQLiDoIvXnKosJtwH1E4otPMTDVSBE5X8FBQYuE3XHteSdVfo",
"space_policy" : "offline",
"cache_policy" : "normal",
"compress" : true,
"creation_time" : 1426776087,
"id" : "0300000000000004d3000000000000000000000010",
"cache" : true
}
}