Consulta de las API

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.

offset

No

Long

Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0.

Predeterminado: 0

limit

No

Integer

Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500.

Mínimo: 1

Máximo: 500

Predeterminado: 20

id

No

String

ID de API.

name

No

String

Nombre de la API.

group_id

No

String

ID de grupo de API.

req_protocol

No

String

Protocolo de solicitud.

req_method

No

String

Método de solicitud.

req_uri

No

String

Ruta de solicitud.

auth_type

No

String

Modo de autenticación de seguridad.

env_id

No

String

ID del entorno en el que se ha publicado la API.

type

No

Integer

Tipo de la API.

precise_search

No

String

Nombre del parámetro (name o req_uri) para la coincidencia exacta.

vpc_channel_name

No

String

Nombre del canal de balanceo de carga.

return_data_mode

No

String

Información adicional que se incluirá en los detalles de la API devuelta. Separe los parámetros múltiples con comas (,). "brief" no tiene efecto cuando se utiliza con ningún parámetro "include".

Actualmente, solo se admiten brief, include_group e include_group_backend.

brief: por defecto, que indica que no se incluirá información adicional.

include_group: El resultado devuelto incluirá api_group_info.

include_group_backend: El resultado devuelto incluirá backend_api.

Predeterminado: brief

tags

No

String

Etiqueta de API. Se pueden especificar varias etiquetas de API. La relación entre varios valores de parámetro es OR. Si no se especifica este parámetro, no se especifica ninguna etiqueta de filtrado. Si este parámetro se establece en #no_tags#, se filtran las API sin etiquetas.

Mínimo: 0

Máximo: 128

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.

size

Integer

Longitud de la lista de recursos devuelta.

total

Long

Número de recursos que coinciden con las condiciones de consulta.

apis

Array of ApiInfoPerPage objects

Lista de API.

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.

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

Tiempo de publicación.

Separar el tiempo de varios registros de publicación con barras verticales (|).

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

Información de backend.

api_group_info

ApiGroupCommonInfo object

Información de grupo de API.

req_params

Array of ReqParam objects

Parámetros de solicitud.

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

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 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. 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 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 (_).

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.

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.

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

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.

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

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.

error_code

String

Código de error.

error_msg

String

Mensaje de error.

error_code

String

Código de error.

error_msg

String

Mensaje de error.

error_code

String

Código de error.

error_msg

String

Mensaje de error.

error_code

String

Código de error.

error_msg

String

Mensaje de error.

200

Aceptar

400

Error en la solicitud

401

Sin autorización

403

Prohibido

500

Error del servidor interno