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 compartido (para usuarios existentes)/ Gestión de API/ Consulta de detalles de la API

Actualización más reciente 2025-12-22 GMT+08:00

Ver PDF

Consulta de detalles de la API

Función

Esta API se utiliza para consultar los detalles de una API especificada.

URI

La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.

**Tabla 1** Método de solicitud de HTTP/HTTPS y URI
Método de solicitud	URI
GET	/v1.0/apigw/apis/{id}

En la siguiente tabla se enumeran los parámetros del URI.

**Tabla 2** Descripción de parámetro
Parámetro	Obligatorio	Tipo	Descripción
id	Sí	String	ID de API

Solicitud

N/A

Respuesta

**Tabla 3** Descripción de parámetro
Parámetro	Tipo	Descripción
id	String	ID de API
name	String	Nombre de la API
group_id	String	ID del grupo de API al que pertenece la API
group_name	String	Nombre del grupo de API al que pertenece la API
status	Integer	Estado de la API
type	Integer	Tipo de API
version	String	Versión de la API
req_protocol	String	Solicitud de protocolo
req_method	String	Método de solicitud
req_uri	String	Dirección de acceso
auth_type	String	Modo de autenticación de seguridad
auth_opt	Object	Parámetro del modo de autenticación de seguridad
authorizer_id	String	ID del autorizador personalizado de frontend
match_mode	String	Modo de coincidencia
register_time	Timestamp	Hora en que se creó la API
update_time	Timestamp	Hora de la última modificación de la API
remark	String	Descripción de la API
bakend_type	String	Tipo de backend
run_env_name	String	Nombre del entorno en el que se ha publicado la API
run_env_id	String	ID del entorno en el que se ha publicado la API
publish_id	String	ID del registro de publicación
arrange_necessary	Integer	Indica si se requiere orquestación.
tag	String	Etiqueta de nombre de servicio, que debe descartarse
tags	[]String	Etiquetas de API
cors	Bool	Indica si se admite CORS.
body_remark	String	Descripción del cuerpo de solicitud de API, que puede ser un cuerpo de solicitud de ejemplo, tipo de medio o información de parámetro
result_normal_sample	String	Ejemplo de respuesta para una solicitud correcta
result_failure_sample	String	Ejemplo de respuesta para una solicitud fallida
response_id	String	ID de la respuesta del gateway
backend_api	Dictionary	Detalles de backend de Web.
mock_info	Dictionary	Detalles de backend de Mock
func_info	Dictionary	Detalles del backend de FunctionGraph
req_params	Dictionary	Lista de parámetros de solicitud
backend_params	Dictionary	Lista de parámetros de backend
policy_https	Dictionary	Lista de políticas de backend de web
policy_mocks	Dictionary	Lista de políticas de backend de Mock
policy_functions	Dictionary	Lista de políticas de backend de FunctionGraph

**Tabla 4** Descripción del parámetro de backend_api
Parámetro	Tipo	Descripción
id	String	ID de backend de Web
status	Integer	Estado de backend de web
url_domain	String	Punto de conexión de backend
version	String	Versión de backend de web
req_protocol	String	Solicitud de protocolo
req_method	String	Método de solicitud
req_uri	String	Dirección de acceso
timeout	Integer	Tiempo de espera en milisegundos
register_time	Timestamp	Tiempo de creación
update_time	Timestamp	Hora en la que se modificó por última vez el backend de web
remark	String	Descripción del backend de web
vpc_status	String	Indica si se debe utilizar un canal de VPC.
vpc_info	String	Información del canal de VPC
authorizer_id	String	ID del autorizador personalizado de backend

**Tabla 5** Descripción del parámetro de mock_info
Parámetro	Tipo	Descripción
id	String	ID de backend de simulacro
status	Integer	Estado de backend de simulacro
version	String	Versión de backend de simulacro
result_content	String	Respuesta de simulacro
register_time	Timestamp	Tiempo de creación
update_time	Timestamp	Hora en la que el backend de simulacro fue modificado por última vez
remark	String	Descripción del backend de simulacro

**Tabla 6** Descripción del parámetro de func_info
Parámetro	Tipo	Descripción
id	String	ID de la función
status	Integer	Estado de la función
version	String	Versión de la función
function_urn	String	Función URN
invocation_type	String	Modo de invocación, que puede ser async o sync
register_time	Timestamp	Tiempo de creación
update_time	Timestamp	Hora de la última actualización de la función
timeout	Integer	Tiempo de espera en milisegundos
remark	String	Descripción de la función

**Tabla 7** Descripción del parámetro de req_params
Parámetro	Tipo	Descripción
id	String	ID del parámetro
name	String	Nombre del parámetro
type	String	Tipo de parámetro
location	String	Ubicación del parámetro
default_value	String	Valor predeterminado
sample_value	String	Valor de ejemplo
required	Integer	Indica si el parámetro es obligatorio. El valor puede ser: 1: sí 2: no
valid_enable	Integer	Indica si la comprobación de validez está activada.
remark	String	Descripción del parámetro
enumerations	String	Valor enumerado
min_num	Integer	Valor mínimo, que es válido cuando el tipo de parámetro es NUMBER
max_num	Integer	Valor máximo, que es válido cuando el tipo de parámetro es NUMBER
min_size	Integer	Longitud mínima
max_size	Integer	Longitud máxima
regular	String	Regla de verificación regular (actualmente no soportada)
json_schema	String	Regla de verificación de JSON (actualmente no soportada)

**Tabla 8** Descripción del parámetro de backend_params
Parámetro	Tipo	Descripción
id	String	ID del parámetro
req_param_id	String	ID del parámetro de solicitud al que se asigna el parámetro de backend
name	String	Nombre del parámetro
location	String	Ubicación del parámetro
origin	String	Tipo de parámetro
value	String	Valor del parámetro
remark	String	Descripción del parámetro

**Tabla 9** Descripción de parámetro de policy_https
Parámetro	Tipo	Descripción
id	String	ID de política de backend
name	String	Nombre de backend
url_domain	String	Punto de conexión del backend de la política
req_protocol	String	Solicitud de protocolo
req_method	String	Método de solicitud
req_uri	String	Dirección de acceso
timeout	Integer	Tiempo de espera en milisegundos
vpc_status	String	Indica si se debe utilizar un canal de VPC.
vpc_info	String	Información del canal de VPC
effect_mode	String	Modo efectivo de la política de backend
conditions	Dictionary	Lista de condiciones de política
backend_params	Dictionary	Lista de parámetros de backend

**Tabla 10** Descripción del parámetro de policy_mocks
Parámetro	Tipo	Descripción
id	String	ID de política de backend
name	String	Nombre de backend
result_content	String	Respuesta de simulacro
effect_mode	String	Modo efectivo de la política de backend
conditions	Dictionary	Lista de condiciones de política
backend_params	Dictionary	Lista de parámetros de backend

**Tabla 11** Descripción del parámetro de policy_functions
Parámetro	Tipo	Descripción
id	String	ID de política de backend
name	String	Nombre de backend
version	String	Versión de la función
function_urn	String	Función URN
invocation_type	String	Modo de invocación, que puede ser async o sync
timeout	Integer	Tiempo de espera en milisegundos
effect_mode	String	Modo efectivo de la política de backend
conditions	Dictionary	Lista de condiciones de política
backend_params	Dictionary	Lista de parámetros de backend

**Tabla 12** Descripción del parámetro de las condiciones
Parámetro	Tipo	Descripción
id	String	ID de condición de política de backend
condition_type	String	Tipo de condición
condition_value	String	Valor de la condición
condition_origin	String	Origen de la condición
req_param_name	String	Nombre del parámetro de entrada
req_param_id	String	ID de parámetro de entrada
req_param_location	String	Ubicación del parámetro de entrada

**Tabla 13** Descripción del parámetro de auth_opt
Parámetro	Tipo	Descripción
app_code_auth_type	String	Indica si la autenticación AppCode está habilitada.

Ejemplo de respuesta:

{
  "name": "test",
  "type": 1,
  "version": "V0.0.1",
  "req_protocol": "HTTPS",
  "req_method": "GET",
  "req_uri": "/test/{tenant_id}",
  "auth_type": "APP",
  "auth_opt": {
    "app_code_auth_type": "DISABLE"
  },
  "tags": ["APIG-SN-test", "test"],
  "cors": false,
  "match_mode": "NORMAL",
  "backend_type": "HTTP",
  "group_id": "f71f69876f90456ca6fd18ed012fdc11",
  "result_normal_sample": "hello world!",
  "id": "81efcfd94b8747a0b21e8c04144a4e8c",
  "status": 1,
  "arrange_necessary": 2,
  "register_time": "2018-08-15T03:41:11.0239936Z",
  "update_time": "2018-08-15T03:41:11.0239936Z",
  "group_name": "group0002",
  "backend_api": {
    "url_domain": "xxxxxxxxxxx",
    "req_protocol": "HTTP",
    "req_method": "GET",
    "req_uri": "/test",
    "timeout": 1000,
    "vpc_status": 2,
    "id": "3442ffd031814e3a8f133a9f1ea08453",
    "status": 1,
    "register_time": "2018-08-15T03:41:11.1019236Z",
    "update_time": "2018-08-15T03:41:11.1019236Z"
  },
  "req_params": [
    {
      "name": "tenant_id",
      "type": "STRING",
      "location": "PATH",
      "required": 1,
      "valid_enable": 2,
      "id": "593c5560e0924e00af08fb458f850ecb"
    },
    {
      "name": "city",
      "type": "STRING",
      "location": "QUERY",
      "required": 2,
      "valid_enable": 2,
      "id": "e0b91bc81ae54f8ea850848d782d6e1e"
    }
  ],
  "backend_params": [
    {
      "name": "tenant_id",
      "location": "QUERY",
      "origin": "REQUEST",
      "value": "tenant_id",
      "id": "44e03de2351e43a8b18ba9ec1e71d2e9",
      "req_param_id": "593c5560e0924e00af08fb458f850ecb"
    },
    {
      "name": "city",
      "location": "QUERY",
      "origin": "REQUEST",
      "value": "city",
      "id": "b60fbcb5b86f4f5c8705c445b9bd6325",
      "req_param_id": "e0b91bc81ae54f8ea850848d782d6e1e"
    }
  ],
  "policy_https": [{
    "conditions": [{
      "id": "44e03de2351e43a8b18ba9ec1e71d2e9",
      "condition_type": "pattern",
      "condition_value": "^[0-9]$",
      "condition_origin": "param",
      "req_param_name": "project_id",
      "req_param_id": "b60fbcb5b86f4f5c8705c445b9sda325",
      "req_param_location": "PATH"
    }],
    "backend_params": [{
      "name": "project_id",
      "value": "bbbb",
      "location": "QUERY",
      "origin": "REQUEST",
      "id": "44e03de2351e43a8b18ba9ec1e71d2e8",
      "req_param_id": "593c5560e0924e00af08fb458f850ecb"
    }],
    "effect_mode": "ANY",
    "id": "44e03de2351e43a8b18ba9ec1e71d2e8",
    "name": "policy001",
    "req_method": "GET",
    "req_protocol": "http",
    "req_uri": "/test/policy",
    "timeout": 10000,
    "url_domain": "xxxxxxxxxxx",
    "vpc_status": 2
  }]
}

Códigos de estado

**Tabla 14** Códigos de estado
Código de estado	Descripción
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Tema principal: Gestión de API

Tema anterior: Publicar varias APIs o quitar varias APIs desconectadas

Tema siguiente: Consulta de una lista de API

Comentarios

¿Le pareció útil esta página?

Sí No

Deje algún comentario

Muchas gracias por sus comentarios. Seguiremos trabajando para mejorar la documentación.

El sistema está ocupado. Vuelva a intentarlo más tarde.