Consulta de todas las etiquetas de gateway de un proyecto
Función
Esta API se utiliza para consultar todas las etiquetas de gateway de un proyecto.
Restricciones
Solo los usuarios que hayan sido autorizados con una política que contenga action apig:instanceTags:list pueden invocar a esta API.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /v2/{project_id}/apigw/instance-tags
|
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. |
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ámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
tags |
Array of TmsKeyValues objects |
Etiquetas vinculadas a todos los gateway del proyecto. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
key |
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 |
|
values |
Array of strings |
El valor. Puede introducir letras, dígitos y espacios u otros caracteres especiales (_.:/=+-@) en formato UTF-8. |
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
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"tags" : [ {
"key" : "test-key",
"values" : [ "test-value1", "test-value2" ]
} ]
}
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",
"error_msg" : "Failed to request internal service"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.