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 detalles de la versión de la API

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

Ver PDF

Consulta de detalles de la versión de la API

Función

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

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/versions/{version_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.
version_id	Sí	String	Versión de la 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
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.
status	Integer	Estado de la aplicación. 1: válido
arrange_necessary	Integer	Indica si se debe habilitar la orquestación.
register_time	String	Hora en que se registra la API.
update_time	String	Hora en la que se modificó por última vez la API.
group_name	String	Nombre del grupo de API al que pertenece la API.
group_version	String	Versión del grupo de API al que pertenece la API. El valor predeterminado es V1. Otras versiones no son compatibles. Predeterminado: V1
run_env_id	String	ID del entorno en el que se ha publicado la API. Separar varios ID de entorno con barras verticales (\|).
run_env_name	String	Nombre del entorno en el que se ha publicado la API. Separar varios nombres de entorno con barras verticales (\|).
publish_id	String	ID del registro de publicación. Separar varios ID de registro de publicación con barras verticales (\|).
publish_time	String	Hora en que se publica la versión de la API.
roma_app_name	String	Nombre de la aplicación de integración a la que pertenece la API. Actualmente, este parámetro no es compatible.
ld_api_id	String	ID de la API de backend personalizada correspondiente. Actualmente, este parámetro no es compatible.
backend_api	BackendApi object	Detalles de backend de Web.
api_group_info	ApiGroupCommonInfo object	Información de grupo de API.
func_info	ApiFunc object	Detalles del backend de FunctionGraph.
mock_info	ApiMock object	Detalles de backend de Mock.
req_params	Array of ReqParam objects	Parámetros de solicitud.
backend_params	Array of BackendParam objects	Parámetros de backend.
policy_functions	Array of ApiPolicyFunctionResp objects	Políticas de backend de FunctionGraph.
policy_mocks	Array of ApiPolicyMockResp objects	Políticas de backend de mock.
policy_https	Array of ApiPolicyHttpResp objects	Políticas de backend de Web.
sl_domain	String	Nombre de subdominio que API Gateway asigna automáticamente al grupo de API.
sl_domains	Array of strings	Nombres de subdominio que APIG asigna automáticamente al grupo de API.
version_id	String	ID de versión de la API.

**Tabla 4** 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 5** BackendApi
Parámetro	Tipo	Descripción
authorizer_id	String	ID de autorizador personalizado de backend.
url_domain	String	Dirección de servicio de backend. Una dirección de servicio de backend consiste en un nombre de dominio o dirección IP y un número de puerto, con no más de 255 caracteres. Debe tener el formato "Nombre del host:número de puerto", por ejemplo, apig.example.com:7443. Si no se especifica el número de puerto, se utiliza el puerto HTTPS predeterminado 443 o el puerto HTTP predeterminado 80. Se soportan variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_).
req_protocol	String	Protocolo de solicitud. Puede seleccionar GRPC o GRPCS para el backend de GRPC.
remark	String	Descripción. No puede exceder los 255 caracteres.
req_method	String	Método de solicitud. Para el backend de GRPC, el método de solicitud se fija en POST.
version	String	Versión de backend de web, que puede contener un máximo de 16 caracteres.
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. Se soportan variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_). NOTA: La dirección debe cumplir con las especificaciones de URI. Para el backend de GRPC, la dirección de solicitud se fija en /.
timeout	Integer	Tiempo de espera permitido para que APIG solicite el servicio de backend. Puede establecer el tiempo de espera máximo mediante el elemento de configuración backend_timeout. El valor máximo es de 600,000. Unidad: ms. Mínimo: 1
enable_client_ssl	Boolean	Indica si se debe habilitar la autenticación bidireccional.
retry_count	String	Número de reintentos para solicitar el servicio de backend. El valor predeterminado es –1. El valor oscila entre –1 y 10. –1 indica que las API idempotentes se reintentarán una vez y las API no idempotentes no se reintentarán. POST y PATCH no son idempotentes. GET, HEAD, PUT, OPTIONS y DELETE son idempotentes. Predeterminado: -1
enable_sm_channel	Boolean	Indica si se deben habilitar los algoritmos criptográficos de SM. Esta función solo está disponible si el gateway admite los algoritmos criptográficos SM.
id	String	ID.
status	Integer	Estado del servicio de backend. 1: válido
register_time	String	Tiempo de registro.
update_time	String	Tiempo de actualización.
vpc_channel_info	VpcInfo object	Detalles del canal de VPC. Este parámetro es necesario si vpc_channel_status se establece en 1.
vpc_channel_status	Integer	Indica si se debe utilizar un canal de VPC. 1: Se utiliza un canal de VPC. 2: No se utiliza ningún canal de VPC.

**Tabla 6** ApiGroupCommonInfo
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 de 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

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

**Tabla 9** ApiFunc
Parámetro	Tipo	Descripción
function_urn	String	URN de la función.
remark	String	Descripción. No puede exceder los 255 caracteres.
invocation_type	String	Modo de invocación. async: asíncrono sync: sincrónico
network_type	String	Arquitectura de red de funciones. V1: non-VPC V2: VPC
version	String	Versión de función. Si se pasa un URN de alias de función y una versión, solo se usará el URN de alias. Máximo: 64
alias_urn	String	URN de alias de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión.
timeout	Integer	Tiempo de espera permitido para que APIG solicite el servicio de backend. Si la arquitectura de red de la función se configura en V1, el tiempo de espera máximo es de 60,000. Si la arquitectura de red se configura como V2, el tiempo de espera máximo es de 600,000 y se puede modificar utilizando el parámetro de gateway backend_timeout. Unidad: ms. Mínimo: 1
authorizer_id	String	ID de autorizador personalizado de backend.
req_protocol	String	Protocolo de solicitud de backend de una función. El valor puede ser HTTPS (predeterminado) o GRPCS (disponible cuando el protocolo de solicitud frontend es GRPCS). Predeterminado: HTTPS
id	String	ID.
register_time	String	Tiempo de registro.
status	Integer	Estado del servicio de backend. 1: válido
update_time	String	Tiempo de actualización.

**Tabla 10** ApiMock
Parámetro	Tipo	Descripción
remark	String	Descripción. No puede exceder los 255 caracteres.
result_content	String	Respuesta.
version	String	Versión de la función. No puede superar los 64 caracteres.
authorizer_id	String	ID de autorizador personalizado de backend.
id	String	ID.
register_time	String	Tiempo de registro.
status	Integer	Estado del servicio de backend. 1: válido
update_time	String	Tiempo de actualización.

**Tabla 11** 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.

**Tabla 12** ApiPolicyFunctionResp
Parámetro	Tipo	Descripción
function_urn	String	URN de la función.
invocation_type	String	Modo de invocación. async: asíncrono sync: sincrónico
network_type	String	Arquitectura de red de funciones. V1: non-VPC V2: VPC
version	String	Versión de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión. Máximo: 64
alias_urn	String	URN de alias de función. Si se pasa un URN de alias de función y una versión, se usará el URN de alias y se ignorará la versión.
timeout	Integer	Tiempo de espera permitido para que APIG solicite el servicio de backend. Si la arquitectura de red de la función se configura en V1, el tiempo de espera máximo es de 60,000. Si la arquitectura de red se configura como V2, el tiempo de espera máximo es de 600,000 y se puede modificar utilizando el parámetro de gateway backend_timeout. Unidad: ms. Mínimo: 1
req_protocol	String	Protocolo de solicitud de backend de una función. El valor puede ser HTTPS (predeterminado) o GRPCS (disponible cuando el protocolo de solicitud frontend es GRPCS). Predeterminado: HTTPS
id	String	ID.
effect_mode	String	Modo efectivo de la política de backend. ALL: Se cumplen todas las condiciones. ANY: Se cumple cualquier condición.
name	String	Nombre de backend, que debe comenzar con una letra y puede contener letras, dígitos y guiones bajos (_). Mínimo: 3 Máximo: 64
backend_params	Array of BackendParam objects	Parámetros de backend.
conditions	Array of CoditionResp objects	Condiciones de política.
authorizer_id	String	ID de autorizador personalizado de backend.

**Tabla 13** ApiPolicyMockResp
Parámetro	Tipo	Descripción
id	String	ID.
effect_mode	String	Modo efectivo de la política de backend. ALL: Se cumplen todas las condiciones. ANY: Se cumple cualquier condición.
name	String	Nombre de backend, que debe comenzar con una letra y puede contener letras, dígitos y guiones bajos (_). Mínimo: 3 Máximo: 64
backend_params	Array of BackendParam objects	Parámetros de backend.
conditions	Array of CoditionResp objects	Condiciones de política.
authorizer_id	String	ID de autorizador personalizado de backend.
result_content	String	Respuesta.

**Tabla 14** ApiPolicyHttpResp
Parámetro	Tipo	Descripción
id	String	ID.
effect_mode	String	Modo efectivo de la política de backend. ALL: Se cumplen todas las condiciones. ANY: Se cumple cualquier condición.
name	String	Nombre de backend, que debe comenzar con una letra y puede contener letras, dígitos y guiones bajos (_). Mínimo: 3 Máximo: 64
backend_params	Array of BackendParam objects	Parámetros de backend.
conditions	Array of CoditionResp objects	Condiciones de política.
authorizer_id	String	ID de autorizador personalizado de backend.
url_domain	String	Punto de conexión del backend de la política. Un punto de conexión consiste en un nombre de dominio o dirección IP y un número de puerto, con no más de 255 caracteres. Debe tener el formato "Domain name:Port number", por ejemplo, apig.example.com:7443. Si no se especifica el número de puerto, se utiliza el puerto HTTPS predeterminado 443 o el puerto HTTP predeterminado 80. Se admiten variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_).
req_protocol	String	Protocolo de solicitud. Las opciones incluyen HTTP, HTTPS, GRPC o GRPCS. Puede seleccionar GRPC o GRPCS para el backend de GRPC.
req_method	String	Método de solicitud. Las opciones incluyen GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS y ANY. Esto se corrige a POST para el backend de GRPC.
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. Se admiten variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_). NOTA: La dirección debe cumplir con las especificaciones de URI. Para el backend de GRPC, la dirección de solicitud se fija en /.
timeout	Integer	Tiempo de espera permitido para que APIG solicite el servicio de backend. Puede establecer el tiempo de espera máximo mediante el elemento de configuración backend_timeout. El valor máximo es de 600,000. Unidad: ms. Mínimo: 1
retry_count	String	Número de reintentos para solicitar el servicio de backend. El valor predeterminado es –1. El valor oscila entre –1 y 10. –1 indica que las API idempotentes se reintentarán una vez y las API no idempotentes no se reintentarán. POST y PATCH no son idempotentes. GET, HEAD, PUT, OPTIONS y DELETE son idempotentes. Predeterminado: -1
enable_sm_channel	Boolean	Indica si se deben habilitar los algoritmos criptográficos de SM. Esta función solo está disponible si el gateway admite los algoritmos criptográficos SM.
vpc_channel_info	VpcInfo object	Detalles del canal de VPC. Este parámetro es necesario si vpc_channel_status se establece en 1.
vpc_channel_status	Integer	Indica si se debe utilizar un canal de VPC. 1: Se utiliza un canal de VPC. 2: No se utiliza ningún canal de VPC.

**Tabla 15** BackendParam
Parámetro	Tipo	Descripción
origin	String	Tipo de parámetro. REQUEST: parámetro de backend CONSTANT: parámetro constante SYSTEM: parámetro del sistema
name	String	Nombre del parámetro. El nombre del parámetro debe comenzar con una letra y solo puede contener letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Mínimo: 1 Máximo: 32
remark	String	Descripción, que puede contener un máximo de 255 caracteres.
location	String	Ubicación del parámetro. El valor puede ser PATH, QUERY o HEADER.
value	String	Valor del parámetro, que puede contener un máximo de 255 caracteres. Si el tipo de origen es REQUEST, el valor de este parámetro es el nombre del parámetro en req_params. Si el tipo de origen es CONSTANT, el valor es una constante. Si el tipo de origen es SYSTEM, el valor es un nombre de parámetro del sistema. Los parámetros del sistema incluyen parámetros de gateway, parámetros de autenticación front-end y parámetros de autenticación back-end. Puede establecer los parámetros de autenticación front-end o back-end después de habilitar la autenticación front-end o back-end personalizada. Los parámetros de gateway son los siguientes: $context.sourceIp: dirección IP de origen del invocador de la API. $context.stage: entorno de despliegue en el que se invoca a la API. $context.apiId: ID de API. $context.appId: ID de la aplicación utilizada por la persona que invoca a la API. $context.requestId: ID de solicitud generado cuando se invoca a la API. $context.serverAddr: dirección del servidor de gateway. $context.serverName: nombre del servidor de gateway. $context.handleTime: hora en la que se procesa la solicitud de API. $context.providerAppId: ID de la aplicación utilizada por el propietario de la API. Este parámetro no se admite actualmente. Parámetro de autenticación de frontend: con el prefijo "$context.autorizer.frontend.". Por ejemplo, para devolver "aaa" tras una autenticación personalizada exitosa, establezca este parámetro en "$context.autorizer.frontend.aaa". Parámetro de autenticación de backend: con el prefijo "$context.autorizer.backend.". Por ejemplo, para devolver "aaa" tras una autenticación personalizada exitosa, establezca este parámetro en "$context.autorizer.backend.aaa".
id	String	ID del parámetro.
req_param_id	String	ID de parámetro de solicitud.

**Tabla 16** CoditionResp
Parámetro	Tipo	Descripción
req_param_name	String	Nombre del parámetro de entrada. Este parámetro es necesario si el tipo de política es param.
sys_param_name	String	Nombre de un parámetro de gateway integrado. Este parámetro es necesario si el tipo de política es system. Se soportan los siguientes parámetros: req_path: ruta de solicitud. Por ejemplo, /a/b. req_method: método de solicitud. Por ejemplo, GET. reqPath: ruta de la solicitud, que se descarta. Por ejemplo, /a/b. reqMethod: método de solicitud, que se descarta. Por ejemplo, GET.
cookie_param_name	String	Nombre del parámetro COOKIE. Este parámetro es necesario si el tipo de política es cookie. Mínimo: 0 Máximo: 255
frontend_authorizer_param_name	String	Parámetro del sistema: nombre del parámetro de autenticación frontend. Este parámetro es obligatorio cuando el tipo de política es frontend_authorizer. El nombre del parámetro de autenticación frontend tiene el prefijo $context.authorizer.frontend. Por ejemplo, si el nombre del parámetro de autenticación frontend es user_name, el nombre con el prefijo será $context.authorizer.frontend.user_name.
condition_type	String	Condición de la política. exact: coincidencia exacta enum: enumeración pattern: expresión regular Este parámetro es necesario cuando el tipo de política es param, system, cookie o frontend_authorizer.
condition_origin	String	Tipo de política param: parámetro source: dirección IP de origen system: parámetro del sistema - parámetro integrado de gateway cookie: parámetro COOKIE frontend_authorizer: parámetro del sistema - parámetro de autenticación frontend
condition_value	String	Valor de la política. Máximo: 1024
mapped_param_name	String	Nombre de un parámetro generado después de la orquestación. Este parámetro es obligatorio cuando condition_origin se establece en orchestration. El nombre del parámetro generado debe existir en la regla de orquestación enlazada a la API.
mapped_param_location	String	Ubicación de un parámetro generado después de la orquestación. Este parámetro es obligatorio cuando condition_origin se establece en orchestration. Esta ubicación debe existir en la regla de orquestación enlazada a la API.
id	String	ID.
req_param_id	String	ID de parámetro de entrada.
req_param_location	String	Ubicación del parámetro de entrada.

**Tabla 17** VpcInfo
Parámetro	Tipo	Descripción
ecs_id	String	ID de servidor en la nube.
ecs_name	String	Nombre del servidor en la nube.
cascade_flag	Boolean	Indica si se utiliza el modo en cascada. Actualmente, este parámetro no es compatible.
vpc_channel_proxy_host	String	Host de proxy.
vpc_channel_id	String	ID de canal de VPC.
vpc_channel_port	Integer	Puerto de canal de VPC.

Código de estado: 401

**Tabla 18** 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 19** 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 20** 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 21** 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",
  "auth_opt" : [ {
    "app_code_auth_type" : "DISABLE"
  } ],
  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
  "cors" : false,
  "match_mode" : "NORMAL",
  "backend_type" : "HTTP",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "result_normal_sample" : "Example success response",
  "result_failure_sample" : "Example failure response",
  "id" : "5f918d104dc84480a75166ba99efff21",
  "status" : 1,
  "arrange_necessary" : 2,
  "remark" : "Web backend API",
  "register_time" : "2020-07-31T12:42:51Z",
  "update_time" : "2020-08-02T16:32:47.046289Z",
  "group_name" : "api_group_001",
  "run_env_name" : "RELEASE",
  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
  "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b",
  "publish_time" : "2020-08-03T01:36:00Z",
  "backend_api" : {
    "url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
    "req_protocol" : "HTTPS",
    "req_method" : "GET",
    "req_uri" : "/test/benchmark",
    "timeout" : 5000,
    "id" : "1ce8fda3586d4371bd83c955df37e102",
    "status" : 1,
    "register_time" : "2020-07-31T12:42:51Z",
    "update_time" : "2020-08-02T16:32:47.077029Z",
    "vpc_channel_status" : 1,
    "vpc_channel_info" : {
      "cascade_flag" : false,
      "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
      "vpc_channel_proxy_host" : "www.example.com",
      "vpc_channel_port" : 0
    },
    "retry_count" : "-1"
  },
  "backend_params" : [ {
    "name" : "X-CONSTANT-HEADER",
    "location" : "HEADER",
    "origin" : "CONSTANT",
    "value" : "demo",
    "remark" : "constant_demo",
    "id" : "8cb2eba19e7a4423a4e835647a8b8d76"
  }, {
    "name" : "app-id",
    "location" : "HEADER",
    "origin" : "SYSTEM",
    "value" : "$context.appId",
    "remark" : "App ID of the API caller",
    "id" : "216ddda836e74d528f364ff589d9dd21"
  } ]
}

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.3022",
  "error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b"
}

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

Tema anterior: Consulta de la definición de tiempo de ejecución de una API

Tema siguiente: Desconexión de una versión 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.

¿Cuáles de los siguientes problemas se presentaron?

Contenido diferente a la de la IU del producto

Descripciones poco claras

Falta de ejemplos o código

Pasos incorrectos

No puedo encontrar lo que necesito

Falta de prácticas recomendadas

Comentarios (opcional)

0/500

Seleccione al menos un tipo de problema e ingrese sus comentarios o sugerencias.

Ingrese 500 caracteres como máximo.

Enviar Cancelar