Modificação de um sistema de arquivos compartilhado

Função

Essa API é usada para modificar o nome e a descrição de um sistema de arquivos compartilhado.

URI

• PUT /v2/{project_id}/shares/{share_id}
• Descrição do parâmetro

  Parâmetro	Obrigatoriedade	Tipo	Descrição
  share_id	Sim	String	Especifica o ID do sistema de arquivos compartilhado.
  project_id	Sim	String	Especifica o ID do projeto do operador. Para obter detalhes de como conseguir o ID do projeto, consulte Obtenção de um ID de projeto.

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

  Parâmetro	Obrigatoriedade	Tipo	Descrição
  share	Sim	Object	Especifica os objetos de share.

• Descrição do campo de share

  Parâmetro	Obrigatoriedade	Tipo	Descrição
  display_name	Não	String	Especifica o nome novo do sistema de arquivos compartilhado. O valor consiste de 0 a 255 caracteres.
  display_description	Não	String	Descreve o sistema de arquivos compartilhado. O valor contém de 0 a 255 caracteres.
  is_public	Não	Boolean	(Suportado pela API v2.8 e versões posteriores.) Especifica se um sistema de arquivos pode ser visto publicamente. Se estiver definido como true, o sistema de arquivos pode ser visto publicamente. Se for definido como false, o sistema de arquivos pode ser visto de forma privada. O valor padrão é false.

• Exemplo de solicitação

  {
      "share": {
          "display_name": "testshare",
          "display_description": "test"
      }
  }

Resposta

• Descrição do parâmetro

  Parâmetro	Tipo	Descrição
  share	Object	Especifica os 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 snapshot 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.
  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	(Suportado pelas versões da API de v2.31 a v2.42) Especifica o ID de um grupo de consistência. Este parâmetro é reservado, porque os grupos de consistência não são suportados atualmente.
  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. 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.
  has_replicas	Boolean	(Suportado pelas versões da API da v2.11 a v2.42) Especifica se existe alguma replicação. Este parâmetro é reservado, porque a replicação não é suportada atualmente.
  replication_type	String	(Suportado pelas versões da API da v2.11 a v2.42) Especifica o tipo de replicação. Este parâmetro é reservado, porque a replicação não é suportada atualmente.
  Descrição	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.
  access_rules_status	String	(Suportado pelas versões da API de v2.10 a v2.27). Especifica o status de configuração da regra de acesso. Os valores possíveis são active (efetivo), error (falhou na configuração) e syncing (configuração em andamento).
  share_proto	String	Especifica o protocolo para compartilhar sistemas de arquivos.
  volume_type	String	Especifica o tipo de volume. A definição deste parâmetro é a mesma de share_type.
  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).
  share_type	String	Especifica o ID do tipo de sistema de arquivos.
  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 do que 2.8.
  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 do que 2.8.
  is_public	Boolean	(Suportado pelas versões da API de v2.8 a v2.42). Especifica se um sistema de arquivos pode ser visto publicamente. Se estiver definido como true, o sistema de arquivos pode ser visto publicamente. Se for definido como false, o sistema de arquivos pode ser visto de forma privada. O valor padrão é false.
  source_share_group_snapshot_member_id	String	(Suportado pela API v2.31 e versões posteriores.) Especifica o ID de uma origem de snapshot de consistência. Atualmente, o grupo de consistência não é suportado. Este campo está reservado.
  revert_to_snapshot_support	Boolean	(Suportado pela API v2.27 e versões posteriores.) Especifica se a reversão para snapshot é suportada. No momento, o snapshot não é suportado. Este campo está reservado.
  create_share_from_snapshot_support	Boolean	(Suportado pela API v2.24 e versões posteriores.) Especifica se a criação de sistemas de arquivos compartilhados a partir de snapshot é suportada. No momento, o snapshot não é suportado. Este campo está reservado.
  mount_snapshot_support	Boolean	(Suportado pela API v2.32 e versões posteriores.) Especifica se a montagem de snapshot é suportada. No momento, o snapshot não é suportado. Este campo está reservado.
  user_id	String	(Suportado pela API v2.16 e versões posteriores.) Especifica o ID do usuário.

• Exemplo de resposta

  {
    "share": {
      "status": "available",
      "share_type_name": "sla",
      "description": "test",
      "links": [
        {
          "href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309",
          "rel": "self"
        },
        {
          "href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309",
          "rel": "bookmark"
        }
      ],
      "availability_zone": "az1.dc1",
      "share_network_id": null,
      "share_server_id": null,
      "share_group_id": null,
      "host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b",
      "revert_to_snapshot_support": null,
      "access_rules_status": "active",
      "snapshot_id": null,
      "create_share_from_snapshot_support": null,
      "is_public": true,
      "task_state": null,
      "snapshot_support": true,
      "id": "f26d867f-9876-433d-8db2-25d210f29309",
      "size": 1,
      "source_share_group_snapshot_member_id": null,
      "user_id": "daa3f8f8d7254465841da769298a76f6",
      "name": "manila share",
      "share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b",
      "has_replicas": false,
      "replication_type": null,
      "created_at": "2018-12-25T08:45:22.525899",
      "share_proto": "NFS",
      "volume_type": "sla",
      "mount_snapshot_support": null,
      "project_id": "07412155bf474db9a2f697fd978593d7",
      "metadata": {
        "share_key": "test",
        "share_used": "1",
      }
    }
  }

Códigos de estado

• Normal

  200

• Anormal

  Código de estado	Descrição
  400 Bad Request	O servidor falhou ao 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 poderia 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.