Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Scalable File Service> Referência de API> APIs do SFS Capacity-Oriented> Sistemas de arquivos> Consulta de detalhes sobre todos os sistemas de arquivos compartilhados

Atualizado em 2023-02-27 GMT+08:00

Ver PDF

Consulta de detalhes sobre todos os sistemas de arquivos compartilhados

Função

Essa API é usada para consultar os detalhes sobre todos os sistemas de arquivos compartilhados.

URI

GET /v2/{project_id}/shares/detail?all_tenants={all_tenants}&project_id={project_id}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&is_public={is_public}&name={name}

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 projeto, consulte Obtenção de um ID de projeto.
all_tenants	Não (parâmetro de consulta)	Integer	(Somente administradores) 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	Especifica o ID do locatário que cria o sistema de arquivos compartilhado. Este parâmetro é usado em conjunto 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, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error e shrinking_possible_data_loss_error.
limit	Não (parâmetro de consulta)	Integer	Especifica o número máximo de sistemas de arquivos compartilhados que podem ser retornados.
offset	Não (parâmetro de consulta)	Integer	Especifica o deslocamento para definir o ponto inicial da listagem do sistema de arquivos compartilhado.
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.
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.
name	Não (parâmetro de consulta)	String	Especifica o campo usado para filtragem difusa com base no nome de um sistema de arquivos compartilhado. Esse campo é compatível com a API v2.36 e versões posteriores.

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
Nenhum
Exemplo de solicitação
Nenhum

Resposta

Descrição do parâmetro

Parâmetro	Tipo	Descrição
shares	Array of objects	Especifica a lista dos objetos de share.

Descrição do campo de share

Parâmetro	Tipo	Descrição
links	Array	Especifica os links de sistemas de arquivos compartilhados.
availability_zone	String	Especifica a zona de disponibilidade.
share_server_id	String	Especifica o ID para gerenciar serviços de compartilhamento.
share_network_id	String	Especifica o ID da rede de compartilhamento. Este parâmetro é reservado, porque o gerenciamento de rede de compartilhamento não é suportado atualmente.
snapshot_id	String	Especifica o ID do instantâneo de origem que é usado para criar o sistema de arquivos compartilhado. Este parâmetro é reservado, porque não há suporte para snapshots no momento.
snapshot_support	Boolean	Especifica se os snapshots são suportados. Este parâmetro é reservado, porque não há suporte para snapshots no momento. Esse campo é compatível com a API v2.2 e versões posteriores.
id	String	Especifica o ID do sistema de arquivos compartilhado.
size	Integer	Especifica o tamanho (GB) do sistema de arquivos compartilhado.
consistency_group_id	String	Especifica o ID do grupo de consistência. Este parâmetro é reservado, porque os grupos de consistência não são suportados atualmente. Este campo é suportado pelas versões da API de v2.31 a v2.42.
project_id	String	Especifica o ID do projeto ao qual o sistema de arquivos compartilhado pertence.
metadata	Object	Define uma ou mais chaves de metadados e pares de valor como um dicionário de cadeias de caracteres. O valor da chave share_used indica a capacidade usada pelo sistema de arquivos, em bytes. A capacidade usada não será exibida se for usada menos de 1 MB de um sistema de arquivos do SFS Capacity-Oriented. O valor da chave enterprise_project_id indica o ID do projeto empresarial ao qual o sistema de arquivos pertence.
status	String	Especifica o status do sistema de arquivos compartilhado.
task_state	String	Especifica o status de migração de dados. Este parâmetro é reservado, porque a migração de dados não é suportada atualmente. Esse campo é compatível com a API v2.5 e versões posteriores.
has_replicas	Boolean	Especifica se existem réplicas. Este parâmetro é reservado, porque a replicação não é suportada atualmente. Este campo é suportado pelas versões da API de v2.11 a v2.42.
replication_type	String	Especifica o tipo de replicação. Este parâmetro é reservado, porque a replicação não é suportada atualmente. Este campo é suportado pelas versões da API de v2.11 a v2.42.
description	String	Descreve o sistema de arquivos compartilhado.
host	String	Especifica o nome do host.
name	String	Especifica o nome do sistema de arquivos compartilhado.
created_at	String	Especifica o carimbo de data e hora quando o sistema de arquivos compartilhado foi criado.
share_proto	String	Especifica o protocolo para compartilhar sistemas de arquivos.
share_type_name	String	Especifica o tipo de serviço de armazenamento atribuído ao sistema de arquivos compartilhado, como armazenamento de alto desempenho (composto por SSDs) e armazenamento de grande capacidade (composto por discos SATA). Esse campo é compatível com a API v2.6 e versões posteriores.
share_type	String	Especifica o ID do tipo de sistema de arquivos.
volume_type	String	Especifica o tipo de volume. A definição deste parâmetro é a mesma de share_type.
export_locations	Array	Lista os locais de montagem. Atualmente, apenas um único local de montagem é suportado. Esse parâmetro existe somente quando X-Openstack-Manila-Api-Version especificado no cabeçalho da solicitação é menor que 2.9.
export_location	String	Especifica a localização da montagem. Esse parâmetro existe somente quando X-Openstack-Manila-Api-Version especificado no cabeçalho da solicitação é menor que 2.9.
is_public	Boolean	Especifica o nível de visibilidade do sistema de arquivos compartilhado. Se true for retornado, o sistema de arquivos pode ser visto publicamente. Se false for retornado, o sistema de arquivos pode ser visto privadamente. O valor padrão é false.

Exemplo de resposta

{
    "shares": [
        {
            "links": [
                {
                    "href": "https://192.168.170.97:8796/v2/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a",
                    "rel": "self"
                },
                {
                    "href": "https://192.168.170.97:8796/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a",
                    "rel": "bookmark"
                }
            ],
            "export_location": "sfs.dong.com:/share-e1c2d35e",
            "availability_zone": "az1.dc1",
            "share_network_id": null,
            "snapshot_id": null,
            "id": "54d0bac6-45c8-471c-bf0d-16ffd81ef88a",
            "size": 1,
            "share_type": "default",
            "": null,
            "project_id": "da0f615c35eb4d72812d1547a77b5394",
            "metadata": { 
                          
                         "share_used": "1048576000000",
                                                                                        },
            "status": "available",
            "description": "test description",
            "export_locations": ["sfs.dong.com:/share-e1c2d35e"],
            "host": "DJ01@9656beb1-7ce2-4c46-9911-ecd51ab632bf#9656beb1-7ce2-4c46-9911-ecd51ab632bf",
            "is_public": false,
            "name": "cl01",
            "created_at": "2017-07-07T03:15:06.858662",
            "share_proto": "NFS",
            "volume_type": "default"
        }
]
}

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 e senha de usuário 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	Falha 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.