Consulta de sistemas de archivos compartidos por etiqueta

Función

Esta API se utiliza para consultar sistemas de archivos compartidos por etiqueta.

URI

• POST /v2/{project_id}/sfs/resource_instances/action
• Descripción del parámetro

  Parámetro	Obligatorio	Tipo	Descripción
  project_id	Sí	String	Especifica el ID de proyecto del operador. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.

Request Header

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

Solicitud

• Descripción del parámetro

  Parámetro	Obligatorio	Tipo	Descripción
  offset	No	String	Especifica la ubicación del índice. El valor es una cadena de caracteres que consta de 0 y enteros positivos. El valor predeterminado es 0. El primer registro del resultado de la consulta es el registro offset+1 que cumple los criterios de la consulta.
  limit	No	String	Especifica el número máximo de registros de consulta. El valor es una cadena de caracteres que consta de enteros. El valor predeterminado es 1000. El valor varía de 1 a 1000. El número de registros devueltos no puede exceder el valor de limit.
  action	Sí	String	Especifica el identificador de operación. Los valores posibles son filter y count. Utilice el filter para consultar los detalles de un sistema de archivos compartido mediante etiquetas.
  matches	No	Array of matches	Especifica el campo de consulta del sistema de archivos. Si este parámetro se deja nulo, todos los sistemas de archivos compartidos del inquilino se buscarán de forma predeterminada.
  tags	No	Array of tags	Especifica el campo de búsqueda de etiquetas, que es una lista de etiquetas. Sólo se pueden devolver sistemas de archivos compartidos que contengan todas las etiquetas enumeradas. Las etiquetas en este criterio de búsqueda están en la relación AND. Específicamente, un sistema de archivos compartido sólo se puede buscar cuando cumple con todos los criterios de búsqueda de etiquetas. En la estructura clave-valores de cada condición de búsqueda de etiqueta, los valores de etiqueta están en la relación OR. Si no se especifica el valor de las tags, todos los sistemas de archivos compartidos cumplen con el requisito de este campo de búsqueda de etiquetas. Este campo contiene un máximo de 10 claves de etiqueta y cada clave de etiqueta tiene un máximo de 10 valores de etiqueta. El valor de etiqueta correspondiente a cada clave de etiqueta puede ser una matriz vacía, pero la estructura no puede faltar. Las claves de etiqueta deben ser únicas. Los valores de etiqueta en una estructura clave-valores deben ser únicos.
  tags_any	No	Array of tags	Especifica el campo de búsqueda de etiquetas, que es una lista de etiquetas. Se devolverán los sistemas de archivos compartidos que contengan cualquier etiqueta de la lista. Las etiquetas en este criterio de búsqueda están en la relación OR. Específicamente, se puede buscar en un sistema de archivos compartido siempre que cumpla con una condición de búsqueda de etiqueta. En la estructura clave-valores de cada condición de búsqueda de etiqueta, los valores de etiqueta están en la relación OR. Si no se especifica el valor de tags_any, todos los sistemas de archivos compartidos cumplen con el requisito de este campo de búsqueda de etiquetas. Este campo contiene un máximo de 10 claves de etiqueta y cada clave de etiqueta tiene un máximo de 10 valores de etiqueta. El valor de etiqueta correspondiente a cada clave de etiqueta puede ser una matriz vacía, pero la estructura no puede faltar. Las claves de etiqueta deben ser únicas. Los valores de etiqueta en una estructura clave-valores deben ser únicos.
  not_tags	No	Array of tags	Especifica el campo de búsqueda de etiquetas, que es una lista de etiquetas. Sólo se devolverán sistemas de archivos compartidos que no contengan ninguna de las etiquetas enumeradas. Las etiquetas en este criterio de búsqueda están en la relación NOR. Específicamente, un sistema de archivos compartido sólo se puede buscar cuando no cumple ningún criterio de búsqueda de etiquetas. En la estructura clave-valores de cada condición de búsqueda de etiqueta, los valores de etiqueta están en la relación OR. Si no se especifica el valor de not_tags, todos los sistemas de archivos compartidos cumplen con el requisito de este campo de búsqueda de etiquetas. Este campo contiene un máximo de 10 claves de etiqueta y cada clave de etiqueta tiene un máximo de 10 valores de etiqueta. El valor de etiqueta correspondiente a cada clave de etiqueta puede ser una matriz vacía, pero la estructura no puede faltar. Las claves de etiqueta deben ser únicas. Los valores de etiqueta en una estructura clave-valores deben ser únicos.
  not_tags_any	No	Array of tags	Especifica el campo de búsqueda de etiquetas, que es una lista de etiquetas. Se devolverán los sistemas de archivos compartidos que no contengan ninguna de las etiquetas enumeradas. Las etiquetas en este criterio de búsqueda están en la relación NAND. Específicamente, se puede buscar en un sistema de archivos compartido siempre que no cumpla con una condición de búsqueda de etiqueta. En la estructura clave-valores de cada condición de búsqueda de etiqueta, los valores de etiqueta están en la relación OR. Si no se especifica el valor de not_tags_any, todos los sistemas de archivos compartidos cumplen con el requisito de este campo de búsqueda de etiquetas. Este campo contiene un máximo de 10 claves de etiqueta y cada clave de etiqueta tiene un máximo de 10 valores de etiqueta. El valor de etiqueta correspondiente a cada clave de etiqueta puede ser una matriz vacía, pero la estructura no puede faltar. Las claves de etiqueta deben ser únicas. Los valores de etiqueta en una estructura clave-valores deben ser únicos.
  sys_tags	No	Array of tags	Solo el permiso op_service puede usar este campo para filtrar recursos. Actualmente, TMS solo puede invocar una clave de estructura de etiquetas, _sys_enterprise_project_id. Actualmente, key contiene solo un valor. 0 indica el proyecto de empresa predeterminado. sys_tags y las condiciones de filtrado de etiquetas de inquilino (tags, tags_any, not_tags, y not_tags_any) no se pueden usar al mismo tiempo.

  

  En los parámetros de solicitud, los campos de búsqueda de etiquetas tags, tags_any, not_tags, y not_tags_any son opcionales y se pueden combinar entre sí. Tales campos de búsqueda de etiquetas están en la relación AND.

• Descripción del campo de match

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave. El valor se fija a resource_name.
  value	Sí	String	Especifica el valor. value indica el nombre de un sistema de archivos compartido. Una cadena vacía especifica una coincidencia exacta y solo se pueden consultar sistemas de archivos compartidos cuyos nombres estén vacíos. Una cadena no vacía especifica una consulta difusa (insensible a mayúsculas y minúsculas). El valor puede contener un máximo de 255 caracteres.

• Descripción del campo de tag

  Parámetro	Obligatorio	Tipo	Descripción
  key	Sí	String	Especifica la clave de la etiqueta. Una clave de etiqueta puede contener un máximo de 127 caracteres. Este parámetro no se puede dejar en blanco.
  values	Sí	Array of strings	Muestra los valores. Cada valor puede contener un máximo de 255 caracteres. Si el valor se deja vacío, se hace coincidir cualquier valor. Los valores están en la relación OR.

• Solicitud de ejemplo

  {
      "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": []
      }]
  }

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  Recursos	Array of resources	Especifica la lista de sistemas de archivos compartidos que cumplen los criterios de consulta.
  total_count	Integer	Especifica el número total de sistemas de archivos compartidos que cumplen los criterios de consulta. NOTA: total_count especifica el número total de sistemas de archivos compartidos que cumplen los criterios de consulta, en lugar del número devuelto después de establecer offset y limit.

• Estructura de datos del campo de resource

  Parámetro	Tipo	Descripción
  resource_id	String	Especifica el ID del sistema de archivos compartido.
  resource_detail	Object	Especifica los detalles del recurso. El valor es un objeto de recurso, utilizado para la extensión. Este valor se deja vacío por defecto.
  tags	Array of resource_tags	Especifica la lista de etiquetas. Si no existen etiquetas, el valor es un array vacío por defecto.
  sys_tags	Array of tags	Solo el permiso op_service puede obtener este campo. Actualmente, solo se utiliza una clave de estructura de etiquetas, _sys_company_project_id. Actualmente, key contiene solo un valor. 0 indica el proyecto de empresa predeterminado. Este campo no se puede devolver en escenarios non-op_service.
  resource_name	String	Especifica el nombre del recurso.

• Estructura de datos del campo resource_tag

  Parámetro	Tipo	Descripción
  key	String	Especifica la clave de etiqueta. El valor puede contener un máximo de 36 caracteres. Este parámetro no se puede dejar en blanco. No puede contener caracteres ASCII no imprimibles (0-31) o los siguientes caracteres: =*<>\,|/.
  value	String	Especifica el valor de etiqueta. El valor contiene un máximo de 43 caracteres y puede ser una cadena vacía. No puede contener caracteres ASCII no imprimibles (0-31) o los siguientes caracteres: =*<>\,|/.

• Ejemplo de respuesta

  {
      "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	Descripción
  400 Bad Request	Valor no válido.
  401 Unauthorized	Error de autenticación.
  403 Forbidden	El acceso a la página solicitada está prohibido.
  404 Not Found	No se encontró el recurso solicitado.
  500 Internal Server Error	La solicitud no se completa debido a un error de servicio.