Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/Volume Operations
GETVolume OperationsSince 0.6SynchronousAuth Required

GetVolumeFormat

GetVolumeFormat

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • formatsListRequired

    See formats.

    • formatStringRequired

      The volume format.

    • masterHypervisorTypeStringRequired

      The default hypervisor type.

    • supportingHypervisorTypesListRequired

      The list of supported hypervisor types.

Endpoint

GET/zstack/v1/volumes/formats

/zstack/v1/volumes/formats

Operation ID

GetVolumeFormat

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/volumes/formats?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "formats": [ { "format": "iso", "masterHypervisorType": "KVM", "supportingHypervisorTypes": [ "ESX", "KVM" ] } ] }

Change History

This API has no change history records yet.

View all change history