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/ API de gateway dedicados (V2)/ Gestión de grupos de API/ Consulta de los detalles del grupo de API
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de los detalles del grupo de API

Función

Esta API se utiliza para consultar los detalles de un grupo de API.

Método de invocación

Para obtener más información, véase invocación de API.

URI

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

Tabla 1 Parámetros de ruta

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.

group_id

Sí

String

ID de grupo de API.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado 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

Tabla 3 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

id

String

ID.

name

String

Nombre del grupo de API.

status

Integer

Estado.

  • 1: válido

sl_domain

String

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

register_time

String

Tiempo 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

No se soporta actualmente.

url_domains

Array of UrlDomain objects

Nombres de dominio independientes enlazados al grupo de API.

sl_domain_access_enabled

Boolean

Si el nombre de dominio de depuración es accesible. Opciones: true y false.

Predeterminado: true

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 invocaciones a la API.

Actualmente, este parámetro no es compatible.

time_interval

Integer

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

Actualmente, este parámetro no es compatible.

time_unit

String

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

Actualmente, este parámetro no es compatible.

is_default

Integer

Indica si el grupo de 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. V2 no se soporta actualmente.

roma_app_id

String

ID de la aplicación de integración a la que pertenece el grupo de 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 de API.

Actualmente, este parámetro no es compatible.
Tabla 4 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: no resuelto
  • 2: resolucionando
  • 3: resuelto
  • 4: resolución fallida

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

verified_client_certificate_enabled

Boolean

Si se debe habilitar la verificación de certificados de cliente. Este parámetro solo está disponible cuando hay un certificado enlazado. Se habilita por defecto si trusted_root_ca existe, y se deshabilita si trusted_root_ca no existe.

Predeterminado: false

is_has_trusted_root_ca

Boolean

Si existe un certificado raíz (CA) de confianza. El valor es true si existe trusted_root_ca en el certificado asociado.

Predeterminado: false

ingress_http_port

Integer

Puerto HTTP de entrada vinculado al nombre de dominio. -1 indica que no hay ningún puerto disponible y que el protocolo no es compatible. En este caso, puede utilizar el puerto predeterminado 80. En los puertos de entrada HTTP del gateway se deben incluir otros puertos válidos. El valor oscila entre 1024 y 49151.

Al crear un nombre de dominio, si no se establece este parámetro, se utiliza el puerto predeterminado 80. Si se configura este parámetro, se debe configurar https_port. Si tanto http_port como https_port necesitan usar el puerto predeterminado, deje ambos parámetros en blanco.

Si no se especifica este parámetro al modificar el nombre de dominio, el número de puerto permanece sin cambios.

Mínimo: -1

Máximo: 49151

ingress_https_port

Integer

Puerto de HTTPS de entrada vinculado al nombre de dominio. -1 indica que no hay ningún puerto disponible y que el protocolo no es compatible. En este caso, puede utilizar el puerto predeterminado 443. En los puertos de entrada HTTPS del gateway se deben incluir otros puertos válidos. El valor oscila entre 1024 y 49151.

Al crear un nombre de dominio, si no se establece este parámetro, se utiliza el puerto predeterminado 443. Si se configura este parámetro, se debe configurar http_port. Si tanto http_port como https_port necesitan usar el puerto predeterminado, deje ambos parámetros en blanco.

Si no se especifica este parámetro al modificar el nombre de dominio, el número de puerto permanece sin cambios.

Mínimo: -1

Máximo: 49151

ssl_infos

Array of SslInfo objects

Lista de certificados SSL.
Tabla 5 SslInfo

Parámetro

Tipo

Descripción

ssl_id

String

ID de certificado SSL.

ssl_name

String

Nombre del certificado SSL.

algorithm_type

String

Tipo de algoritmo de certificado:

  • RSA
  • ECC
  • SM2

type

String

Alcance del certificado:

  • instance
  • global

Predeterminado: global

Código de estado: 400

Tabla 6 Parámetros del cuerpo 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 7 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Tabla 8 Response body parameters

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 404

Tabla 9 Parámetros del cuerpo 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 del cuerpo de respuesta

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

{
  "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,
  "sl_domain_access_enabled" : true
}

Código de estado: 400

Error en la solicitud

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

Código de estado: 401

Sin autorización

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

Código de estado: 403

Prohibido

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

Código de estado: 404

No se ha encontrado

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

Código de estado: 500

Error del servidor interno

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

Códigos de estado

Código de estado

Descripción

200

Aceptar

400

Error en la solicitud

401

Sin autorización

403

Prohibido

404

No se ha encontrado

500

Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de grupos de API