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 API/ Consulta de la definición de tiempo de ejecución de una API
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

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 invoca a la API en un entorno.

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}/apis/runtime/{api_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.

api_id

Sí

String

ID de API.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

env_id

No

String

ID del entorno en el que se publica la 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 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 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

name

String

Nombre de la API.

Puede contener de 3 a 255 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos y estos caracteres especiales: -_./:()

type

Integer

Tipo de la API.

  • 1: API pública
  • 2: API privada

version

String

Versión de la API.

Máximo: 16

req_protocol

String

Protocolo de solicitud de API:

  • HTTP
  • HTTPS
  • BOTH: Se admiten tanto HTTP como HTTPS.
  • GRPCS

Predeterminado: HTTPS

req_method

String

Método de solicitud de API. Si el protocolo de solicitud se configura en GRPC, el método de solicitud se fija en POST.

req_uri

String

Dirección de solicitud, que puede contener parámetros de solicitud entre llaves ({}). Por ejemplo, /getUserInfo/{userId}. Caracteres especiales, como asteriscos (*), barras diagonales (/), signos de porcentaje (%), guiones (-), guiones bajos (_) y puntos (.), están permitidos. Puede contener un máximo de 512 caracteres y debe cumplir con las especificaciones de URI.

NOTA:

La dirección debe cumplir con las especificaciones de URI.

auth_type

String

Modo de autenticación de API. Opciones:

  • NONE
  • APP
  • IAM
  • AUTHORIZER: autenticación personalizada. Cuando auth_type se establece en AUTHORIZER, el campo authorizer_id es obligatorio.

auth_opt

AuthOpt object

Parámetro de autenticación de seguridad.

cors

Boolean

Indica si se admite CORS.

  • TRUE: soportado
  • FALSE: no soportado

Predeterminado: false

match_mode

String

Modo de coincidencia de API:

  • SWA: coincidencia de prefijo
  • NORMAL: Coincidencia exacta

    Valor predeterminado: NORMAL

backend_type

String

Tipo de backend. Opciones:

  • HTTP: backend de web
  • FUNCTION: backend de FunctionGraph. Cuando backend_type se establece en FUNCTION, el campo func_info es obligatorio.
  • MOCK: backend de mock. Cuando backend_type se configura en MOCK, el campo mock_info es obligatorio.
  • GRPC: backend de gRPC.

remark

String

Descripción de API. No puede exceder los 255 caracteres.

group_id

String

ID del grupo de API al que pertenece la API.

body_remark

String

Cuerpo de solicitud de API, que puede ser un cuerpo de solicitud de ejemplo, tipo de medio o parámetros. Asegúrese de que el cuerpo de la solicitud no exceda los caracteres 20,480.

result_normal_sample

String

Ejemplo de respuesta para una solicitud exitosa. Asegúrese de que la respuesta no exceda los caracteres 20,480.

No está disponible si el protocolo de solicitud está establecido en GRPC.

result_failure_sample

String

Ejemplo de respuesta para una solicitud fallida. Asegúrese de que la respuesta no exceda los caracteres 20,480.

No está disponible si el protocolo de solicitud está establecido en GRPC.

authorizer_id

String

ID del autorizador personalizado de frontend

tags

Array of strings

Etiqueta. Se utilice letras, dígitos y caracteres especiales (-*#%.:_) y se comienza con una letra. Por defecto, se admiten 10 etiquetas. Para aumentar la cuota, póngase en contacto con el soporte técnico para modificar la configuración API_TAG_NUM_LIMIT.

Mínimo: 1

Máximo: 128

response_id

String

ID de respuesta de grupo.

roma_app_id

String

ID de aplicación de integración.

Actualmente, este parámetro no es compatible.

domain_name

String

Nombre de dominio personalizado enlazado a la API.

Actualmente, este parámetro no es compatible.

tag

String

Etiqueta.

Este campo quedará obsoleto. Puede utilizar el campo de etiquetas en su lugar.

content_type

String

Tipo de contenido de solicitud:

application/json

application/xml

multipart/form-data

text/plain

is_send_fg_body_base64

Boolean

Especifica si se debe realizar la codificación Base64 en el cuerpo para la interacción con FunctionGraph. No es necesario codificar el cuerpo usando Base64 solo cuando content_type se establece en application/json.

Escenario de aplicación:

  • Autenticación personalizada
  • Complemento de disyuntores vinculados con la política de reducción del backend de FunctionGraph
  • API con backend de FunctionGraph

Predeterminado: true

id

String

ID de API.

group_name

String

Nombre del grupo de API al que pertenece la API.

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.

sl_domain

String

Nombre del subdominio del grupo API.

sl_domains

Array of strings

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

req_params

Array of ReqParam objects

Parámetros de solicitud.
Tabla 5 AuthOpt

Parámetro

Tipo

Descripción

app_code_auth_type

String

Indica si la autenticación de AppCode está habilitada. Este parámetro solo es válido si auth_type se establece en App. El valor predeterminado es DISABLE.

  • DISABLE: La autenticación de AppCode está deshabilitada.
  • HEADER: La autenticación de AppCode está habilitada y el AppCode se encuentra en el encabezado.

Predeterminado: DISABLE
Tabla 6 ReqParam

Parámetro

Tipo

Descripción

name

String

Nombre del parámetro.

El nombre del parámetro puede contener de 1 a 32 caracteres y debe comenzar con una letra. Solo se permiten letras, dígitos, guiones (-), guiones bajos (_) y puntos (.).

type

String

Tipo de parámetro.

location

String

Ubicación del parámetro.

default_value

String

Valor predeterminado.

sample_value

String

Ejemplo de valor.

required

Integer

Indica si el parámetro es necesario.

1: sí

2: no

El valor de este parámetro es 1 si Location se establece en PATH y 2 si Location se establece en otro valor.

valid_enable

Integer

Indica si la comprobación de validez está activada.

  • 1: habilitado
  • 2: deshabilitado

Predeterminado: 2

remark

String

Descripción. No puede exceder los 255 caracteres.

enumerations

String

Valor enumerado.

min_num

Integer

Valor mínimo.

Este parámetro es válido cuando type se establece en NUMBER.

max_num

Integer

Valor máximo.

Este parámetro es válido cuando type se establece en NUMBER.

min_size

Integer

Longitud mínima.

Este parámetro es válido cuando type se establece en STRING.

max_size

Integer

Longitud máxima.

Este parámetro es válido cuando type se establece en STRING.

regular

String

Regla de validación de expresiones regulares.

Actualmente, este parámetro no es compatible.

json_schema

String

Regla de validación JSON.

Actualmente, este parámetro no es compatible.

pass_through

Integer

Indica si se debe transferir el parámetro de forma transparente.

1: sí

2: no

orchestrations

Array of strings

Las reglas de orquestación de parámetros de solicitud se priorizan en la misma secuencia que la lista.

La regla none_value de una lista de reglas tiene la prioridad más alta. Se puede enlazar un máximo de una regla none_value.

La regla predeterminada de una lista de reglas tiene la prioridad más baja. Se puede enlazar un máximo de una regla predeterminada.

La regla de orquestación de preprocesamiento no se puede utilizar como última regla de orquestación excepto la regla predeterminada.

Solo se puede enlazar un parámetro de cada API con reglas de orquestación únicas. El número de reglas de orquestación que se pueden vincular está limitado por cuota. Para obtener más información, véase "Notas y restricciones" en Descripción del servicio de APIG.

id

String

ID del parámetro.

Código de estado: 401

Tabla 7 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: 403

Tabla 8 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: 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

{
  "name" : "Api_http",
  "type" : 1,
  "version" : "V0.0.1",
  "req_protocol" : "HTTPS",
  "req_method" : "GET",
  "req_uri" : "/test/http",
  "auth_type" : "AUTHORIZER",
  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
  "auth_opt" : {
    "app_code_auth_type" : "DISABLE"
  },
  "cors" : false,
  "match_mode" : "NORMAL",
  "backend_type" : "HTTP",
  "remark" : "Web backend API",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "result_normal_sample" : "Example success response",
  "result_failure_sample" : "Example failure response",
  "id" : "5f918d104dc84480a75166ba99efff21",
  "group_name" : "api_group_001",
  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "run_env_name" : "RELEASE",
  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ]
}

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.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}

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

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 API