Consulta de gateways por etiqueta
Función
Esta API se utiliza para consultar gateways por etiqueta.
Restricciones
Cuando se utiliza una política para autorizar usuarios, solo se puede invocar a esta API cuando se incluye la acción apig:instance:listByTags.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/resource-instances/filter
|
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ámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
offset |
No |
Long |
Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0 |
|
limit |
No |
Integer |
Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20 |
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 |
|---|---|---|---|
|
without_any_tag |
No |
Boolean |
Los recursos que se van a consultar no contienen etiquetas. Si este parámetro se establece en true, se consultan todos los recursos sin etiquetas. En este caso, el campo tags se ignora. Si este parámetro se establece en false o no se especifica, no tiene efecto. |
|
tags |
No |
Array of TmsKeyValues objects |
Etiquetas incluidas. Se incluyen un máximo de 20 claves. Cada clave puede tener un máximo de 20 valores. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos. Array Length: 0 - 20 |
|
sys_tags |
No |
Array of TmsKeyValues objects |
Proyecto empresarial. Solo el permiso op_service puede usar este campo para filtrar recursos. Si no se utiliza sys_tags, los recursos se filtran por tag. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos. Array Length: 0 - 1 |
|
matches |
No |
Array of TmsMatchesKeyValue objects |
Criterios de búsqueda. La clave de etiqueta es el campo que debe coincidir. Actualmente, solo se soporta resource_name. El valor de etiqueta indica el valor coincidente. Compruebe si se requiere una coincidencia difusa basada en el valor de clave. Por ejemplo, si key se establece en resource_name, se realiza la búsqueda de prefijos. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
key |
No |
String |
Clave. Incluye UTF-8 letras, dígitos, espacios o caracteres especiales (_.:=+-@). No se puede empezar con _sys_ porque es una etiqueta de sistema. Mínimo: 1 Máximo: 128 |
|
values |
No |
Array of strings |
El valor. Puede introducir letras, dígitos y espacios u otros caracteres especiales (_.:/=+-@) en formato UTF-8. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
key |
No |
String |
Especifica el campo que se va a coincidir.
|
|
value |
No |
String |
Indica el valor. El valor puede contener letras UTF-8, dígitos, espacios y los siguientes caracteres: (_.:/=+-@) : / = + - @ Máximo: 255 |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
resources |
Array of TmsResourceResp objects |
Gateways |
|
total_count |
Integer |
Cantidad total de registros. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
resource_id |
String |
ID de gateway. |
|
resouce_detail |
String |
Descripción detallada del gateway. No admitido. |
|
resource_name |
String |
Nombre del gateway. |
|
tags |
Array of TmsKeyValue objects |
Etiquetas vinculadas al gateway. Array Length: 0 - 20 |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
key |
String |
Clave. Incluye UTF-8 letras, dígitos, espacios o caracteres especiales (_.:=+-@). No se puede empezar con _sys_ porque es una etiqueta de sistema. Mínimo: 1 Máximo: 128 |
|
value |
String |
Value. Puede introducir letras, dígitos y espacios u otros caracteres especiales (_.:/=+-@) en formato UTF-8. Mínimo: 0 Máximo: 255 |
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
-
Filtrado de gateways por etiqueta
{ "without_any_tag" : false, "tags" : [ { "key" : "test-key", "values" : [ "test-value" ] } ], "matches" : [ { "key" : "resource_name", "value" : "test-apig" } ] } -
Filtrar gateways por ID de proyecto de empresa
{ "without_any_tag" : false, "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "0" ] } ], "matches" : [ { "key" : "resource_name", "value" : "test-apig" } ] }
Ejemplo de respuestas
Código de estado: 200
Gateways devueltos
{
"resources" : [ {
"resource_id" : "e120108ac331422cb539d8609e9a7bb2",
"resouce_detail" : null,
"resource_name" : "apig_instance",
"tags" : [ {
"key" : "test-key",
"value" : "test-value"
} ]
} ],
"total_count" : 1
}
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 |
|---|---|
|
200 |
Gateways devueltos |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.
