ListarVolumesAtivos
Sugerir alterações
PDFs
Você pode usar o ListActiveVolumes Método para obter a lista de volumes ativos atualmente no sistema. A lista de volumes é ordenada por VolumeID e pode ser retornada em várias partes (páginas).
Parâmetros
Este método possui os seguintes parâmetros de entrada:
| Nome | Descrição | Tipo | Valor padrão | Obrigatório |
|---|---|---|---|---|
incluirVolumesVirtuais |
Por padrão, os volumes virtuais estão incluídos na resposta. Para excluir volumes virtuais, defina como falso. |
booleano |
verdadeiro |
Não |
startVolumeID |
Iniciando o retorno do VolumeID. Caso não exista nenhum volume com esse VolumeID, o próximo volume na ordem de VolumeID será usado como início da lista. Para navegar pela lista, passe o VolumeID do último volume na resposta anterior + 1. |
inteiro |
0 |
Não |
limite |
Número máximo de objetos de informação de volume a serem retornados. 0 (zero) retorna todos os volumes (ilimitados). |
inteiro |
(ilimitado) |
Não |
Valor de retorno
Este método tem o seguinte valor de retorno:
Nome |
Descrição |
Tipo |
volumes |
Lista de volumes ativos. |
volumevariedade |
Exemplo de solicitação
As solicitações para esse método são semelhantes ao seguinte exemplo:
{
"method": "ListActiveVolumes",
"params": {
"startVolumeID" : 0,
"limit" : 1000
},
"id" : 1
}
Exemplo de resposta
Devido à extensão deste exemplo de resposta, ele está documentado em um tópico suplementar.
Novidade desde a versão
9,6