Adición o eliminación de etiquetas de oyente por lotes
Función
Esta API se utiliza para agregar etiquetas por lotes a o eliminar etiquetas de un oyente.
Restricciones
- Se puede agregar un máximo de 10 etiquetas a un oyente.
- Esta API es idempotente.
- Tenga en cuenta lo siguiente cuando agregue etiquetas:
- Si hay claves duplicadas en el cuerpo de la solicitud, se notifica un error.
- Si no hay claves duplicadas en el cuerpo de la solicitud pero la clave del cuerpo de la solicitud existe en la base de datos, se sobrescribe la clave de la base de datos.
- Tenga en cuenta lo siguiente cuando elimine las etiquetas:
- Si la etiqueta que se va a eliminar no existe, la eliminación se considera correcta de forma predeterminada.
- El rango de valores del conjunto de caracteres de etiqueta no se verifica.
- No puede faltar el cuerpo de la estructura de etiquetas y la clave no se puede dejar en blanco ni establecer una string vacía.
URI
POST /v2.0/{project_id}/listeners/{listener_id}/tags/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto en el que se utiliza la etiqueta. |
listener_id |
Sí |
String |
Especifica el ID del oyente al que se agregarán las etiquetas o del que se eliminarán. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
tags |
Sí |
Array |
Muestra las etiquetas. Para más detalles, consulte Tabla 4. |
action |
Sí |
String |
Especifica el identificador de operación. El valor puede ser uno de los siguientes:
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
Sí |
String |
Especifica la clave de etiqueta.
|
value |
Sí |
String |
Especifica el valor de etiqueta.
|
Parámetros de respuesta
No hay
Ejemplo de la solicitud
- Ejemplo de solicitud 1
POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags/action { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
- Ejemplo de solicitud 2
POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags/action { "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
Código de estado
Para más detalles, consulte Códigos de estado.