Consulta de sistemas de arquivos compartilhados por tag

Função

Essa API é usada para consultar sistemas de arquivos compartilhados por tag.

URI

• POST /v2/{project_id}/sfs/resource_instances/action
• 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.

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
  offset	Não	String	Especifica a localização do índice. O valor é uma cadeia de caracteres que consiste em 0 e inteiros positivos. O valor padrão é 0. O primeiro registro no resultado da consulta é o registro offset+1 que atende aos critérios da consulta.
  limit	Não	String	Especifica o número máximo de registros de consulta. O valor é uma cadeia de caracteres que consiste em números inteiros. O valor padrão é 1.000. O valor varia de 1 a 1.000. O número de registros retornados não pode exceder o valor de limit.
  action	Sim	String	Especifica o identificador da operação. Os valores possíveis são filter e count. Use filter para consultar detalhes de um sistema de arquivos compartilhado usando tags.
  matches	Não	Array of matches	Especifica o campo de consulta do sistema de arquivos. Se esse parâmetro for deixado nulo, todos os sistemas de arquivos compartilhados do locatário serão pesquisados por padrão.
  tags	Não	Array of tags	Especifica o campo de pesquisa de tags, que é uma lista de tags. Somente sistemas de arquivos compartilhados contendo todas as tags listadas podem ser retornados. As tags neste critério de pesquisa estão na relação AND. Especificamente, um sistema de arquivos compartilhado pode ser pesquisado somente quando ele atende a todos os critérios de pesquisa de tags. Na estrutura de valores-chave de cada condição de pesquisa de tag, os valores de tag estão na relação OR. Se o valor das tags não for especificado, todos os sistemas de arquivos compartilhados atendem aos requisitos desse campo de pesquisa de tags. Este campo contém um máximo de 10 chaves de tag e cada chave de tag tem um máximo de 10 valores de tag. O valor da tag correspondente a cada chave da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando. As chaves de tag devem ser únicas. Os valores de tag em uma estrutura de valores-chave devem ser exclusivos.
  tags_any	Não	Array of tags	Especifica o campo de pesquisa de tags, que é uma lista de tags. Sistemas de arquivos compartilhados que contenham qualquer tag listada serão retornados. As tags neste critério de pesquisa estão na relação OR. Especificamente, um sistema de arquivos compartilhados pode ser pesquisado desde que atenda a uma condição de pesquisa de tags. Na estrutura de valores-chave de cada condição de pesquisa de tag, os valores de tag estão na relação OR. Se o valor de tags_any não for especificado, todos os sistemas de arquivos compartilhados atendem aos requisitos desse campo de pesquisa de tags. Este campo contém um máximo de 10 chaves de tag e cada chave de tag tem um máximo de 10 valores de tag. O valor da tag correspondente a cada chave da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando. As chaves de tag devem ser únicas. Os valores de tag em uma estrutura de valores-chave devem ser exclusivos.
  not_tags	Não	Array of tags	Especifica o campo de pesquisa de tags, que é uma lista de tags. Somente sistemas de arquivos compartilhados que não contenham nenhuma das tags listadas serão retornados. As tags neste critério de pesquisa estão na relação NOR. Especificamente, um sistema de arquivos compartilhados pode ser pesquisado somente quando não atende a nenhum critério de pesquisa de tags. Na estrutura de valores-chave de cada condição de pesquisa de tag, os valores de tag estão na relação OR. Se o valor de not_tags não for especificado, todos os sistemas de arquivos compartilhados atendem aos requisitos desse campo de pesquisa de tags. Este campo contém um máximo de 10 chaves de tag e cada chave de tag tem um máximo de 10 valores de tag. O valor da tag correspondente a cada chave da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando. As chaves de tag devem ser únicas. Os valores de tag em uma estrutura de valores-chave devem ser exclusivos.
  not_tags_any	Não	Array of tags	Especifica o campo de pesquisa de tags, que é uma lista de tags. Sistemas de arquivos compartilhados que não contenham nenhuma das tags listadas serão retornados. As tags neste critério de pesquisa estão na relação NAND. Especificamente, um sistema de arquivos compartilhados pode ser pesquisado, desde que não atenda a uma condição de pesquisa de tags. Na estrutura de valores-chave de cada condição de pesquisa de tag, os valores de tag estão na relação OR. Se o valor de not_tags_any não for especificado, todos os sistemas de arquivos compartilhados atendem aos requisitos desse campo de pesquisa de tags. Este campo contém um máximo de 10 chaves de tag e cada chave de tag tem um máximo de 10 valores de tag. O valor da tag correspondente a cada chave da tag pode ser uma matriz vazia, mas a estrutura não pode estar faltando. As chaves de tag devem ser únicas. Os valores de tag em uma estrutura de valores-chave devem ser exclusivos.
  sys_tags	Não	Array of tags	Somente a permissão op_service pode usar esse campo para filtrar recursos. Atualmente, o TMS pode invocar apenas uma chave de estrutura de tag, _sys_enterprise_project_id. Atualmente, key contém apenas um valor. 0 indica o projeto corporativo padrão. As condições de filtragem de sys_tags e de tag de locatário (tags, tags_any, not_tags e not_tags_any) não podem ser usadas ao mesmo tempo.

  

  Nos parâmetros de solicitação, os campos de pesquisa de tags, tags_any, not_tags e not_tags_any são opcionais e podem ser combinados entre si. Esses campos de pesquisa de tags estão na relação AND.

• Descrição do campo de match

  Parâmetro	Obrigatoriedade	Tipo	Descrição
  key	Sim	String	Especifica a chave. O valor é fixado em resource_name.
  value	Sim	String	Especifica o valor. value indica o nome de um sistema de arquivos compartilhado. Uma cadeia de caracteres vazia especifica uma correspondência exata e somente sistemas de arquivos compartilhados cujos nomes estão vazios podem ser consultados. Uma cadeia não vazia especifica uma consulta difusa (não diferencia maiúsculas de minúsculas). O valor pode conter no máximo 255 caracteres.

• Descrição do campo de tag

  Parâmetro	Obrigatoriedade	Tipo	Descrição
  key	Sim	String	Especifica a chave da tag. Uma chave de tag pode conter no máximo 127 caracteres. Este parâmetro não pode ser deixado em branco.
  values	Sim	Array of strings	Lista os valores. Cada valor pode conter no máximo 255 caracteres. Se o valor for deixado vazio, qualquer valor será correspondido. Os valores estão na relação OR.

• Exemplo de solicitação

  {
      "offset": "0",
      "limit": "100",
      "action": "filter",
      "matches": [{
          "key": "resource_name",
          "value": "share_name"
      }],
      "tags": [{
          "key": "key1",
          "values": ["value2"]
      }, {
          "key": "key2",
          "values": []
      }],
      "tags_any": [{
          "key": "key3",
          "values": ["value3"]
      }, {
          "key": "key4",
          "values": []
      }],
      "not_tags": [{
          "key": "key5",
          "values": ["value5"]
      }, {
          "key": "key6",
          "values": []
      }],
      "not_tags_any": [{
          "key": "key7",
          "values": ["value7", "value8"]
      }, {
          "key": "key9",
          "values": []
      }]
  }

Resposta

• Descrição do parâmetro

  Parâmetro	Tipo	Descrição
  resources	Array of resources	Especifica a lista de sistemas de arquivos compartilhados que atendem aos critérios de consulta.
  total_count	Integer	Especifica o número total de sistemas de arquivos compartilhados que atendem aos critérios de consulta. NOTA: total_count especifica o número total de sistemas de arquivos compartilhados que atendem aos critérios de consulta, em vez do número retornado após definir offset e limit.

• Estrutura de dados do campo de resource

  Parâmetro	Tipo	Descrição
  resource_id	String	Especifica o ID do sistema de arquivos compartilhado.
  resource_detail	Object	Especifica os detalhes do recurso. O valor é um objeto de recurso, usado para extensão. Este valor é deixado vazio por padrão.
  Tags	Array of resource_tags	Especifica a lista de tags. Se nenhuma tag existir, o valor é uma matriz vazia por padrão.
  sys_tags	Array of tags	Somente a permissão op_service pode obter esse campo. Atualmente, apenas uma chave de estrutura de tags é usada, _sys_enterprise_project_id. Atualmente, key contém apenas um valor. 0 indica o projeto corporativo padrão. Esse campo não pode ser retornado em cenários non-op_service
  resource_name	String	Especifica o nome de recurso.

• Estrutura de dados do campo resource_tag

  Parâmetro	Tipo	Descrição
  key	String	Especifica a chave de tag. O valor pode conter no máximo 36 caracteres. Este parâmetro não pode ser deixado em branco. Não pode conter caracteres ASCII não imprimíveis (0-31) ou os seguintes caracteres: =*<>\,|/
  value	String	Especifica o valor da tag. O valor contém um máximo de 43 caracteres e pode ser uma cadeia de caracteres vazia. Não pode conter caracteres ASCII não imprimíveis (0-31) ou os seguintes caracteres: =*<>\,|/

• Exemplo de resposta

  {
      "resources":[
          {
              "resource_detail":{},
              "resource_id":"b1f3f06f-344d-446b-a4bf-647a225debae",
              "resource_name":"share_name",
              "tags":[
                  {
                      "key":"key1", 
                      "value": "value1"
                  },
                  {
                      "key":"key2", 
                      "value": "value2"
                  }
              ]
          }
      ],
      "total_count":1
  }

Códigos de estado

• Normal

  200

• Anormal

  Código de estado	Descrição
  400 Bad Request	Valor inválido.
  401 Unauthorized	Autenticação falhou.
  403 Forbidden	O acesso à página solicitada é proibido.
  404 Not Found	O recurso solicitado não foi encontrado.
  500 Internal Server Error	A solicitação não foi concluída devido a um erro de serviço.