Consulta de todos os sistemas de arquivos compartilhados

Função

Essa API é usada para listar as informações básicas de todos os sistemas de arquivos compartilhados.

URI

• GET /v2/{project_id}/shares?all_tenants={all_tenants}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&project_id={project_id}&is_public={is_public}
• Descrição do parâmetro

  Parâmetro	Obrigatoriedade	Tipo	Descrição
  project_id	Sim	String	Especifica o ID do projeto do operador. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de um ID de projeto.
  all_tenants	Não (parâmetro de consulta)	Boolean	Este parâmetro está disponível apenas para usuários com permissões de administrador. Especifica se devem ser listados os sistemas de arquivos compartilhados de todos os locatários. Para listar os sistemas de arquivos compartilhados de todos os locatários, defina-o como 1. Para listar apenas os sistemas de arquivos compartilhados do locatário atual, defina-o como 0.
  project_id	Não (parâmetro de consulta)	String	Este parâmetro está disponível apenas para usuários com permissões de administrador. Especifica o ID do projeto ao qual o sistema de arquivos compartilhado pertence. Este parâmetro precisa ser usado junto com all_tenants.
  status	Não (parâmetro de consulta)	String	Filtra os sistemas de arquivos compartilhados por status. Os valores possíveis são: creating: o sistema de arquivos compartilhados está sendo criado. error: o sistema de arquivos compartilhados falha ao ser criado. available: o sistema de arquivos compartilhados está disponível. deleting: o sistema de arquivos compartilhado está sendo excluído. error_deleting: o sistema de arquivos compartilhados falha ao ser excluído. extending: o sistema de arquivos compartilhados está sendo expandido. extending_error: o sistema de arquivos compartilhados falha ao ser expandido. shrinking: o sistema de arquivos compartilhados está sendo reduzido. shrinking_error: o sistema de arquivos compartilhados não consegue ser encolhido. shrinking_possible_data_loss_error: o sistema de arquivos compartilhados falha ao encolher devido à perda de dados. manage_starting: o gerenciamento do sistema de arquivos compartilhado é iniciado. manage_error: o sistema de arquivos compartilhados falha ao ser gerenciado. unmanage_starting: o cancelamento do gerenciamento do sistema de arquivos compartilhado é iniciado. unmanage_error: falha ao cancelar o gerenciamento do sistema de arquivos compartilhado. unmanaged: o sistema de arquivos compartilhado não é gerenciado.
  limit	Não (parâmetro de consulta)	Integer	Especifica o número máximo de sistemas de arquivos compartilhados que podem ser retornados. Se este parâmetro não for especificado, todos os sistemas de arquivos compartilhados serão retornados por padrão.
  offset	Não (parâmetro de consulta)	Integer	Especifica o deslocamento para definir o ponto inicial da listagem do sistema de arquivos compartilhado. O valor deve ser superior ou igual a 0.
  sort_key	Não (parâmetro de consulta)	String	Especifica a palavra-chave para classificar os sistemas de arquivos compartilhados consultados. Os valores possíveis são id, status, size, host, share_proto, availability_zone_id, user_id, project_id, created_at, updated_at, display_name, name, share_type_id, share_network_id e snapshot_id. Por padrão, o valor é classificado por created_at.
  sort_dir	Não (parâmetro de consulta)	String	Especifica a direção para classificar sistemas de arquivos compartilhados. Os valores possíveis são asc (ascendente) e desc (descendente).
  is_public	Não (parâmetro de consulta)	String	Quando esse parâmetro é definido como true, o locatário atual pode consultar todos os seus próprios sistemas de arquivos compartilhados e sistemas de arquivos compartilhados de outros locatários cujo is_public está definido como true. Quando esse parâmetro é definido como false, o locatário atual pode consultar somente os sistemas de arquivos compartilhados pertencentes ao locatário.
  enterprise_project_id	Não (parâmetro de consulta)	String	Especifica o projeto empresarial ao qual os sistemas de arquivos compartilhados estão vinculados. Para consultar a vinculação de sistemas de arquivos compartilhados do usuário atual a todos os projetos da empresa, use o parâmetro all_granted_eps.

Request Header

The operation message header is the same as that of a common request. For details, see Tabela 3.

Solicitação

• Descrição do parâmetro

  Nenhuma

Resposta

• Descrição do parâmetro

  Parâmetro	Tipo	Descrição
  shares	Array of objects	Para obter detalhes, consulte a descrição do campo de share.

• Description of the share field

  Parâmetro	Tipo	Descrição
  id	String	Especifica o ID do sistema de arquivos compartilhado.
  links	Array of objects	Especifica as informações de vínculo de solicitação do sistema de arquivos compartilhado.
  name	String	Especifica o nome do sistema de arquivos compartilhado.

• Exemplo de resposta

  {
     
      "shares": [
      {
          "id": "1390cb29-539b-4926-8953-d8d6b106071a",
          "links": [
          {
              "href": "https://192.168.196.47:8796/v2/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a",
              "rel": "self"
          },
          {
              "href": "https://192.168.196.47:8796/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a",
              "rel": "bookmark"
          }
          ],
          "name": null
      }
  ]
  }

Códigos de estado

• Normal

  200

• Anormal

  Código de estado	Descrição
  400 Bad Request	O servidor não conseguiu processar a solicitação.
  401 Unauthorized	Você precisa digitar o nome de usuário e senha para acessar a página solicitada.
  403 Forbidden	O acesso à página solicitada é proibido.
  404 Not Found	A página solicitada não foi encontrada.
  405 Method Not Allowed	Você não tem permissão para usar o método especificado na solicitação.
  406 Not Acceptable	A resposta gerada pelo servidor não pôde ser aceita pelo cliente.
  407 Proxy Authentication Required	Você deve usar o servidor proxy para autenticação. Em seguida, a solicitação pode ser processada.
  408 Request Timeout	A solicitação expirou o tempo limite.
  409 Conflict	A solicitação não pôde ser processada devido a um conflito.
  500 Internal Server Error	Falhou ao concluir a solicitação porque ocorre um erro de serviço interno.
  501 Not Implemented	Falhou ao concluir a solicitação porque o servidor não suporta a função solicitada.
  502 Bad Gateway	Falhou ao concluir a solicitação porque a solicitação é inválida.
  503 Service Unavailable	Falhou ao concluir a solicitação porque o serviço não está disponível.
  504 Gateway Timeout	Ocorreu um erro de tempo limite de gateway.