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 la definición de tiempo de ejecución de una API

Actualización más reciente 2023-03-29 GMT+08:00

Ver PDF

Consulta de la definición de tiempo de ejecución de una API

Función

Esta API se utiliza para consultar la definición de tiempo de ejecución de una API en un entorno específico. La definición de tiempo de ejecución de una API en el entorno RELEASE se consulta si no se especifica ningún entorno.

La definición de una API se clasifica en los siguientes tipos:

Definición temporal: definición de una API utilizada después de la última edición de la API.
Definición de tiempo de ejecución: instantánea de la definición temporal de una API capturada cuando la API se publica en un entorno.

Se accede a la definición de tiempo de ejecución de una API cuando se llama a la API en un entorno.

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/runtime/{id}[?env_id]

Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
La condición de consulta es env_id.

En la siguiente tabla se muestra el parámetro en el URI.

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

Solicitud

**Tabla 3** Descripción de parámetro
Parámetro	Obligatorio	Tipo	Descripción
env_id	No	String	ID del entorno en el que se publica la API

Respuesta

**Tabla 4** 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
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	Security authentication mode parameter
authorizer_id	String	ID del autorizador personalizado de frontend
match_mode	String	Modo de coincidencia
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
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
sl_domain	String	Nombre del subdominio del grupo API
sl_domains	Array of strings	Lista de nombres de subdominio enlazados al grupo de API
req_params	Dictionary	Lista de parámetros de solicitud

**Tabla 5** 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.
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 validación de expresiones regulares
json_schema	String	Regla de validación de JSON

**Tabla 6** 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": "market_api01",
  "type": 1,
  "version": "V0.0.1",
  "req_protocol": "HTTPS",
  "req_method": "GET",
  "req_uri": "/test01",
  "auth_type": "APP",
  "auth_opt": {
    "app_code_auth_type": "HEADER"
  },
  "tags": ["APIG-SN-test", "test"],
  "cors": true,
  "match_mode": "NORMAL",
  "backend_type": "MOCK",
  "remark": "market_api01",
  "group_id": "7f848adc971749cda9c6aff3877cfc3e",
  "body_remark": "market_api01",
  "result_normal_sample": "success",
  "result_failure_sample": "",
  "id": "0e51b689e0784bc884f43756bbf34fa5",
  "group_name": "market_group01",
  "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "run_env_name": "RELEASE",
  "publish_id": "f07eb9f5e5ba4bbfbe89326f5cae99c7",
  "sl_domain": "61297835ff1e4905b6f635dbcdf1777e.apigw.example.com",
  "sl_domains": ["61297835ff1e4905b6f635dbcdf1777e.apigw.example.com", "61297835ff1e4905b6f635dbcdf1777e.apigw.example.cn"],
  "req_params": [
    {
      "name": "project_id",
      "type": "STRING",
      "location": "PATH",
      "default_value": "",
      "sample_value": "",
      "required": 1,
      "valid_enable": 2,
      "remark": "",
      "enumerations": "",
      "min_num": 0,
      "max_num": 0,
      "min_size": 0,
      "max_size": 0,
      "regular": "",
      "json_schema": "",
      "id": "2a61905ea2304186a9422faba2940735"
    }
  ]
}