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 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

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/runtime/{api_id}

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.

api_id

Sí

String

ID de API.
Tabla 2 Parámetros de Query

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 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

name

String

Nombre de API.

Puede contener de 3 a 64 caracteres, empezando por una letra. Solo se permiten letras, dígitos y guiones bajos (_).

type

Integer

Tipo de API.

  • 1: API pública

  • 2: API privada

Valores de enumeración:

  • 1

  • 2

version

String

Versión de la API.

Máximo: 16

req_protocol

String

Solicitud de protocolo.

  • HTTP

  • HTTPS

  • BOTH: Se puede acceder a la API a través de HTTP y HTTPS.

Predeterminado: HTTPS

Valores de enumeración:

  • HTTP

  • HTTPS

  • BOTH

req_method

String

Método de solicitud.

Valores de enumeración:

  • GET

  • POST

  • PUT

  • DELETE

  • HEAD

  • PATCH

  • OPTIONS

  • ANY

req_uri

String

Solicitud de dirección. Puede contener parámetros de solicitud encerrados con corchetes ({}). Por ejemplo, /getUserInfo/{userId}. Se permiten caracteres especiales, como asteriscos (*), signos de porcentaje (%), guiones (-) y guiones bajos (_). Puede contener un máximo de 512 caracteres y debe cumplir con las especificaciones de URI. El valor debe cumplir con las especificaciones de URI.

auth_type

String

Modo de autenticación de API.

  • NONE

  • APP

  • IAM

  • AUTHORIZER

Valores de enumeración:

  • NONE

  • APP

  • IAM

  • AUTHORIZER

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

Valores de enumeración:

  • true

  • false

match_mode

String

Modo de coincidencia de ruta.

  • SWA: coincidencia de prefijo

  • NORMAL: Coincidencia exacta.

El valor predeterminado es NORMAL.

Valores de enumeración:

  • SWA

  • NORMAL

backend_type

String

Tipo de backend.

  • HTTP: backend de web

  • FUNCTION: backend de FunctionGraph

  • MOCK: backend de Mock

Valores de enumeración:

  • HTTP

  • FUNCTION

  • MOCK

remark

String

Descripción de la API. No puede superar 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. El valor no puede superar los caracteres 20,480.

result_failure_sample

String

Ejemplo de respuesta para una solicitud fallida. El valor no puede superar los caracteres 20,480.

authorizer_id

String

ID del autorizador personalizado de frontend.

tags

Array of strings

Etiquetas.

El valor solo puede contener letras, dígitos y guiones bajos (_), y debe comenzar con una letra. Puedes introducir varias etiquetas y separarlas con comas (,).

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 será obsoleta. Puede utilizar el campo de etiquetas en su lugar.

content_type

String

Tipo de contenido de solicitud:

  • application/json

  • application/xml

  • multipart/form-date

  • text/plain

Actualmente, este parámetro no es compatible.

Valores de enumeración:

  • application/json

  • application/xml

  • multipart/form-date

  • text/plain

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 AppCode está habilitada. Este parámetro solo es válido si auth_type está establecido 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

Valores de enumeración:

  • DISABLE

  • HEADER
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 medios (-), guiones bajos (_) y puntos (.).

type

String

Tipo de parámetro.

Valores de enumeración:

  • STRING

  • NUMBER

location

String

Ubicación del parámetro.

Valores de enumeración:

  • PATH

  • QUERY

  • HEADER

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.

Valores de enumeración:

  • 1

  • 2

valid_enable

Integer

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

  • 1: habilitado

  • 2: deshabilitado

Predeterminado: 2

Valores de enumeración:

  • 1

  • 2

remark

String

Descripción. No puede superar 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

Valores de enumeración:

  • 1

  • 2

id

String

ID del parámetro.

Código de estado: 401

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

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: 404

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

{
  "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

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: 404

Not Found

{
  "error_code" : "APIG.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}

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

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de API