Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ API Gateway/ Referencia de la API/ Las API de gateway dedicado (V2)/ Gestión de grupo API/ Consulta de grupos de API
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Consulta de grupos de API

Función

Esta API se utiliza para consultar grupos de API.

Puedes consultar todos los grupos de API de su cuenta como inquilino o consultar grupos de API de todos los inquilinos mediante una cuenta de administrador.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

Sí

String

Gateway ID, que se puede obtener de la información de gateway en la consola APIG.
Tabla 2 Parámetros de Query

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

id

No

String

ID de grupo de API.

name

No

String

Nombre del grupo API.

precise_search

No

String

Nombre del parámetro para la coincidencia exacta. Solo se admiten los nombres de grupo de API.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario. Se puede obtener llamando 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

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

size

Integer

Longitud de la lista de recursos devuelta.

total

Long

Número de recursos que coinciden con las condiciones de consulta.

groups

Array of ApiGroupInfo objects

Grupos de API.
Tabla 5 ApiGroupInfo

Parámetro

Tipo

Descripción

id

String

ID.

name

String

Nombre del grupo API.

status

Integer

Estado.

  • 1: válido

Valores de enumeración:

  • 1

sl_domain

String

Nombre de subdominio que APIG asigna automáticamente al grupo de API.

register_time

String

Hora de creación.

update_time

String

Hora de la última modificación.

on_sell_status

Integer

Indica si el grupo de API aparece en la lista KooGallery.

  • 1: en la lista

  • 2: no en la lista

  • 3: en revisión

url_domains

Array of UrlDomain objects

Nombres de dominio independientes enlazados al grupo API.

sl_domains

Array of strings

Nombres de subdominio asignados automáticamente.

remark

String

Descripción.

call_limits

Integer

Número total de veces que se puede acceder a todas las API del grupo de API. Tenga en cuenta la capacidad de carga útil del servicio de backend al establecer este parámetro. De forma predeterminada, no hay límite en el número de llamadas a la API.

Actualmente, este parámetro no es compatible.

time_interval

Integer

Período de tiempo para limitar el número de llamadas a la API.

Actualmente, este parámetro no es compatible.

time_unit

String

Unidad de tiempo para limitar el número de llamadas API.

Actualmente, este parámetro no es compatible.

is_default

Integer

Indica si el grupo API es el grupo predeterminado.

version

String

Versión de grupo.

  • V1: grupo global

  • V2: grupo de nivel de aplicación

El valor predeterminado es V1. Este parámetro no se admite actualmente.

roma_app_id

String

ID de la aplicación de integración a la que pertenece el grupo API.

Este parámetro es necesario cuando la versión de grupo es V2.

Actualmente, este parámetro no es compatible.

roma_app_name

String

Nombre de la aplicación de integración a la que pertenece el grupo API.

Actualmente, este parámetro no es compatible.
Tabla 6 UrlDomain

Parámetro

Tipo

Descripción

id

String

ID de dominio.

domain

String

Nombre de dominio.

cname_status

Integer

Estado de resolución CNAME del nombre de dominio.

  • 1: not resolved

  • 2: resolving

  • 3: resolved

  • 4: resolution failed

ssl_id

String

ID de certificado SSL.

ssl_name

String

Nombre del certificado SSL.

min_ssl_version

String

Versión mínima de SSL. Se admiten TLS 1.1 y TLS 1.2.

Predeterminado: TLSv1.1

Valores de enumeración:

  • TLSv1.1

  • TLSv1.2

Código de estado: 400

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 10 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

Ninguna

Ejemplo de respuestas

Código de estado: 200

OK

{
  "total" : 2,
  "size" : 2,
  "groups" : [ {
    "update_time" : "2020-07-31T06:55:55Z",
    "name" : "api_group_001",
    "on_sell_status" : 2,
    "remark" : "API group 1",
    "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
    "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
    "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "register_time" : "2020-07-31T06:55:55Z",
    "status" : 1,
    "is_default" : 2
  }, {
    "update_time" : "2020-06-24T15:29:42.421926Z",
    "name" : "api_group_002",
    "on_sell_status" : 2,
    "remark" : "API group 2",
    "sl_domain" : "02a8ab3cb2784de5a096852829671ae7.apic.****.com",
    "sl_domains" : [ "02a8ab3cb2784de5a096852829671ae7.apic.****.com", "02a8ab3cb2784de5a096852829671ae7.apic.****.cn" ],
    "id" : "02a8ab3cb2784de5a096852829671ae7",
    "register_time" : "2020-06-24T15:29:42.421926Z",
    "status" : 1,
    "is_default" : 2
  } ]
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de estado: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de estado: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de grupo API