Skip to main content

Templates

post__templates_create

Code samples

POST /templates/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /templates/create

Create an application template.

Body parameter

{
  "Application": "string",
  "Description": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body TemplateElementCreate false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

delete__templates_delete

Code samples

DELETE /templates/delete HTTP/1.1

Accept: application/json

DELETE /templates/delete

Delete an application template.

Parameters

Name In Type Required Description
name query string false The name of the application template to delete.
async query boolean false none
uncommitAndAggregateId query string false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__templates_edit

Code samples

PUT /templates/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /templates/edit

Edit an application template.

Body parameter

{
  "Application": "string",
  "Description": "string"
}

Parameters

Name In Type Required Description
application query string false none
async query boolean false none
uncommitAndAggregateId query string false none
body body TemplateElementEdit false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__templates_list

Code samples

GET /templates/list HTTP/1.1

Accept: application/json

GET /templates/list

List application templates.

Parameters

Name In Type Required Description
name query string false Limit results by the application template name.
desc query boolean false Show description of templates.
cg query boolean false Show consistency groups within the applications.
vols query boolean false Show volumes within the application templates.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "Id": 0,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string"
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "VolumeShadowCopySupport": true,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "Id": 0,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string"
            }
          ]
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success TemplateElementApiResult
400 Bad Request Bad Request string

put__templates_snapshots_schedule

Code samples

PUT /templates/snapshots/schedule HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /templates/snapshots/schedule

Schedule snapshots.

Body parameter

{
  "Frequency": [
    "string"
  ],
  "Retention": [
    "string"
  ]
}

Parameters

Name In Type Required Description
cgid query integer(int64) false none
application query string false none
volume query string false none
async query boolean false none
uncommitAndAggregateId query string false none
body body TemplatesSnapshotsSchedule false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

post__templates_volumes_create

Code samples

POST /templates/volumes/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /templates/volumes/create

Create a new volume template.

Body parameter

{
  "Application": "string",
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "SnapshotCapacityInBytes": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body VolumeTemplateElementCreate false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

delete__templates_volumes_delete

Code samples

DELETE /templates/volumes/delete HTTP/1.1

Accept: application/json

DELETE /templates/volumes/delete

Delete an application template volume.

Parameters

Name In Type Required Description
application query string false The name of the application template.
volumes query array[string] false Delete specific volumes within the application template (and not the entire application template).
async query boolean false none
uncommitAndAggregateId query string false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__templates_volumes_edit

Code samples

PUT /templates/volumes/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /templates/volumes/edit

Change the parameters of a volume within an application template.

Body parameter

{
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "SnapshotCapacityInBytes": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Parameters

Name In Type Required Description
application query string false none
volume query string false none
async query boolean false none
uncommitAndAggregateId query string false none
body body VolumeTemplateElementEdit false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__templates_volumes_list

Code samples

GET /templates/volumes/list HTTP/1.1

Accept: application/json

GET /templates/volumes/list

List application volume templates.

Parameters

Name In Type Required Description
name query string false Limit results by the application template name.
desc query boolean false Show description of templates.
cg query boolean false Show consistency groups within the applications.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "Id": 0,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string"
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "VolumeShadowCopySupport": true,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "Id": 0,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string"
            }
          ]
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success TemplateElementApiResult
400 Bad Request Bad Request string
No Comments
Back to top