Etiquetado de objetos
Los datos se pueden definir, categorizar y clasificar expresamente en IBM Cloud® Object Storage utilizando metadatos asociados, denominados "etiquetas". Este documento le mostrará cómo tomar el control total en "etiquetar" los objetos que representan los datos.
Objetos y metadatos
La organización de los datos puede ser una tarea compleja. Los métodos básicos, como el uso de prefijos clave como "carpetas" de la organización son un gran comienzo para las estructuras jerárquicas. Pero para una organización más
compleja, necesitará "etiquetasUn identificador definido por el usuario adjunto a una agrupación de recursos que están contenidos en una cuenta. Las etiquetas son visibles en toda la cuenta.personalizadas."
Los metadatos pueden describir las relaciones inherentes a los datos y proporcionar más organización que títulos o carpetas. A diferencia de las meras etiquetas, hay dos partes en una etiqueta: una key y una value,
definidas individualmente según sus necesidades.
Antes de empezar
Necesita:
- Una cuenta de IBM Cloud® Platform
- Una instancia de de IBM Cloud Object Storage y un grupo creado para este fin
- Una clave de API de IAM con acceso de Escritor a su grupo o instancia de Object Storage
- Objetos existentes o nuevos a los que se les aplicarán etiquetas.
Lectura de etiquetas
Las etiquetas son accesibles en toda una instancia con los permisos adecuados. Mientras que el verdadero poder organizativo de utilizar etiquetas como principio organizativo se escala con usted, también puede acceder a las etiquetas de forma individual.
Inicie sesión en la consola, seleccionando la instancia de IBM Cloud Object Storage y el grupo donde se representan los datos. Después de haber cargado los archivos en el grupo, puede ver y gestionar las etiquetas en su lugar. Coloque el cursor sobre los puntos suspensivos al final de cualquier fila que represente sus datos (almacenados como un objeto), y seleccione "Administrar sus etiquetas" en las opciones del menú.
Una solicitud "GET" correctamente formada y autenticada con el parámetro de consulta ?tagging es todo lo que se necesita para acceder a las etiquetas para los objetos utilizando curl. Los ejemplos aquí utilizados
utilizan señales portadoras generadas utilizando este ejemplo. Además del identificador de grupo y la clave de objeto, también necesitará el punto final correcto. También se muestra el objeto XML resultante, donde el elemento "Tag" se repetirá para cada etiqueta asignada al objeto. Si no hay etiquetas, la respuesta devolverá XML con un elemento vacío, <TagSet />.
curl 'https://<endpoint>/<bucketname>/<objectname>?tagging' \
-H 'Authorization: bearer <token>' \
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Tagging xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<TagSet>
<Tag>
<Key>Example Key</Key>
<Value>Value Example</Value>
</Tag>
</TagSet>
</Tagging>
Por supuesto, antes de que se puedan ver las etiquetas hay que crearlas, a las que pasaremos a continuación.
Creación de etiquetas
Las etiquetas deben cumplir con las siguientes restricciones:
- Un objeto puede tener un máximo de 10 etiquetas
- Para cada objeto, cada clave de etiqueta debe ser exclusiva y cada clave de etiqueta sólo puede tener un valor.
- Longitud mínima de clave-1 caracteres Unicode en UTF-8
- Longitud máxima de clave-128 caracteres Unicode en UTF-8
- Tamaño máximo de bytes de clave-256 bytes
- Longitud mínima de valor-0 caracteres Unicode en UTF-8 (el valor de etiqueta puede estar vacío)
- Longitud máxima de valor-256 caracteres Unicode en UTF-8
- Tamaño máximo de byte de valor-512 bytes
- Una clave y valor de etiqueta pueden constar de caracteres alfanuméricos de EE. UU. (
a-z,A-Z,0-9) y espacios representables en UTF-8, y los símbolos siguientes:_,.,*,',-,: - Las claves de etiqueta y los valores distinguen entre mayúsculas y minúsculas
ibm:no se puede utilizar como prefijo de clave para etiquetas
Como se ha indicado anteriormente, inicie sesión en la instancia y vaya al grupo y al objeto que desea "etiquetar". En el panel que aparece al seleccionar "Administrar sus etiquetas", comience haciendo clic en el botón
"Añadir etiquetas +". A continuación, puede añadir etiquetas escribiendo texto en los campos key y value como desee. Añada más etiquetas de una en una, repitiendo los pasos que acaba de completar.
Si no hace clic en "guardar" al completar los cambios, un cuadro de diálogo le recordará las consecuencias. Es decir, los cambios se descartan a menos que se guarden.
Como se ha indicado anteriormente, tendrá que autenticarse para añadir etiquetas a los datos. Si tiene preguntas sobre señales portadoras, consulte este ejemplo.
De nuevo, anote la serie de consulta para trabajar con etiquetas: ?tagging.
curl -X "PUT" 'https://<endpoint>/<bucketname>/<objectname>?tagging' \
-H 'Authorization: bearer <token>' \
-H "content-type: text/plain" \
--data "<Tagging><TagSet><Tag><Key>your key</Key><Value>your text</Value></Tag></TagSet></Tagging>"
El ejemplo describe como se muestra una etiqueta con un key de 'source' y un value de 'text' en el XML enviado como datos en el cuerpo de la solicitud. El esquema del XML tiene que validarse tras la ejecución. Si desea añadir varias etiquetas, duplique el nodo 'Etiqueta' y modifique el contenido de cada clave y elemento de valor en sus especificaciones. Sólo hay un elemento 'TagSet' para cada objeto
y el mandato 'PUT' sustituirá los metadatos existentes por los valores especificados.
curl -X "PUT" "https://s3.test.cloud-object-storage.sample.appdomain.cloud/taggingtest/example-file.csv?tagging" -H "Authorization: bearer ...iOiIyMDIwMTIwNzE0NDkiLCJh..." -H "ibm-service-instance-id: 7nnnnn52-2nn0-nna9-bann-7nnnnn4cc4e7" --data "<Tagging><TagSet><Tag><Key>source</Key><Value>text</Value></Tag></TagSet></Tagging>"
Edición de etiquetas
Una vez que los objetos han sido etiquetados, con el tiempo puede ser necesario modificarlos.
Para editar las etiquetas utilizando la interfaz gráfica, tendrá que iniciar sesión en la consola y acceder a los objetos como se ha descrito anteriormente. Una vez que hayas hecho clic en la opción "Administrar etiquetas", simplemente cambia el contenido de los campos del formulario. Recuerde pulsar "Guardar" cuando haya terminado.
Las solicitudes deben autenticarse para etiquetar los datos. Además, tendrá que mantener mediante programación las etiquetas antiguas mientras actualiza los objetos con información nueva. El ejemplo que se muestra repite las etiquetas de los ejemplos anteriores al añadir una etiqueta nueva.
Recuerde que si se realizan operaciones "PUT" que implican etiquetas, se sobrescribirán las etiquetas actuales.
curl -X "PUT" 'https://<endpoint>/<bucketname>/<objectname>?tagging' \
-H 'Authorization: bearer <token>' \
-H "content-type: text/plain" \
--data "<Tagging><TagSet><Tag><Key>source</Key><Value>text</Value></Tag><Tag><Key>source1</Key><Value>text1</Value></Tag></TagSet></Tagging>"
Eliminación de etiquetas
Después de añadir etiquetas a los objetos, es posible que sea necesario eliminarlos.
Para suprimir las etiquetas utilizando la interfaz gráfica, tendrá que iniciar sesión en la consola y acceder a los objetos como se ha descrito anteriormente. De nuevo, haga clic en la opción "Administrar etiquetas", y en el panel que aparece, elija "eliminar todo" o eliminar una etiqueta a la vez haciendo clic en el icono "papelera" en la misma fila que la etiqueta.
Recuerde pulsar "Guardar" cuando haya terminado.
Tendrá que autenticarse para suprimir etiquetas de los datos. Simplemente utilice el método HTTP "DELETE" con el parámetro de consulta ?tagging para suprimir todas las etiquetas. Si desea suprimir una o más etiquetas
mientras mantiene simultáneamente una o más etiquetas, utilice las instrucciones de "edición" para realizar los cambios.
curl -X "DELETE" 'https://<endpoint>/<bucketname>/<objectname>?tagging' \
-H 'Authorization: bearer <token>' \
-H "content-type: text/plain"
Próximos pasos
Encontrará más detalles sobre las operaciones relacionadas con objetos en la documentación de la API deS3 y más opciones de configuración en la API de configuración.