Adición o eliminación de etiquetas de un gateway
Función
Esta API se utiliza para agregar etiquetas a un gateway o eliminar las etiquetas de un gateway.
Restricciones
Solo los usuarios autorizados con una política que contenga acciones apig:instances:get, apig:instanceTags:create y apig:instanceTags:delete pueden invocar a esta API.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/instance-tags/action
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
action |
Sí |
String |
Operación: crear y eliminar. |
|
tags |
Sí |
Array of TmsKeyValue objects |
Etiquetas. Se puede crear un máximo de 20 etiquetas para el gateway. Longitud de matriz: 0 - 20 |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
key |
No |
String |
Clave. Incluye UTF-8 letras, dígitos, espacios o caracteres especiales (_.:=+-@). No empiece con _sys_ porque es una etiqueta de sistema. Mínimo: 1 Máximo: 128 |
|
value |
No |
String |
El valor. Puede introducir letras, dígitos y espacios u otros caracteres especiales (_.:/=+-@) en formato UTF-8. Mínimo: 0 Máximo: 255 |
Parámetros de respuesta
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
-
Agregar etiquetas para un gateway
{ "action" : "create", "tags" : [ { "key" : "test-key", "value" : "test-value" } ] } -
Eliminar etiquetas de un gateway
{ "action" : "delete", "tags" : [ { "key" : "test-key1", "value" : "test-value" }, { "key" : "test-key2" } ] }
Ejemplo de respuestas
Código de estado: 401
Sin autorización
{
"error_code" : "APIC.7102",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIC.7106",
"error_msg" : "No permissions to request for the method"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIC.9000"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
204 |
Sin contenido |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.