External Volume

List external volumes

GET/api/v2/external-volumes
List external volumes

Pour plus d’informations

Accéder à la page de la commande SQL pour afficher plus d’informations sur les arguments, les options, les exigences relatives aux privilèges et les directives d’utilisation.

Vue

Paramètres de requête

ParamètreDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

Réponse

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create an external volume

POST/api/v2/external-volumes
Create an external volume

Pour plus d’informations

Accéder à la page de la commande SQL pour afficher plus d’informations sur les arguments, les options, les exigences relatives aux privilèges et les directives d’utilisation.

Vue

Paramètres de requête

ParamètreDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Réponse

CodeDescription
200
Successful request.
202

Fetch an external volume

GET/api/v2/external-volumes/{name}
Fetch an external volume

Pour plus d’informations

Accéder à la page de la commande SQL pour afficher plus d’informations sur les arguments, les options, les exigences relatives aux privilèges et les directives d’utilisation.

Vue

Paramètres de chemin

ParamètreDescription
name string
Identifier (i.e. name) for the resource.

Réponse

CodeDescription
200
successful
202

Delete an external volume

DELETE/api/v2/external-volumes/{name}
Delete an external volume

Pour plus d’informations

Accéder à la page de la commande SQL pour afficher plus d’informations sur les arguments, les options, les exigences relatives aux privilèges et les directives d’utilisation.

Vue

Paramètres de requête

ParamètreDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Réponse

CodeDescription
200
202

Undrop an external volume

POST/api/v2/external-volumes/{name}:undrop
Undrop an external volume

Pour plus d’informations

Accéder à la page de la commande SQL pour afficher plus d’informations sur les arguments, les options, les exigences relatives aux privilèges et les directives d’utilisation.

Vue

Réponse

CodeDescription
200
202