Consulta de APIs

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.

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

group_id

No

String

ID de grupo de API.

req_protocol

No

String

Solicitud de protocolo.

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

precise_search

No

String

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

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.

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

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

authorizer_id

String

ID de autorizador personalizado de backend.

url_domain

String

Puede consistir 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 443 predeterminado o el puerto HTTP 80 predeterminado. Se admiten variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_).

req_protocol

String

Solicitud de protocolo.

Valores de enumeración:

• HTTP

• HTTPS

remark

String

Descripción. No puede superar los 255 caracteres.

req_method

String

Método de solicitud.

Valores de enumeración:

• GET

• POST

• PUT

• DELETE

• HEAD

• PATCH

• OPTIONS

• ANY

version

String

Versión de backend de web, que puede contener un máximo de 16 caracteres.

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. Se admiten variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_). El valor debe cumplir con las especificaciones URI.

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 varía de -1 a 10.

Predeterminado: -1

id

String

ID.

status

Integer

Estado del servicio de backend.

• 1: válido

register_time

String

Tiempo de registro.

update_time

String

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

Proxy host.

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

status

Integer

Estado.

• 1: válido

Valores de enumeración:

• 1

sl_domain

String

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

register_time

String

Hora 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: listed

• 2: not listed

• 3: under review

url_domains

Array of UrlDomain objects

Nombres de dominio independientes enlazados al grupo API.

id

String

ID de dominio.

domain

String

Nombre de dominio.

cname_status

Integer

Estado de resolución CNAME del nombre de dominio.

• 1: not resolved

• 2: resolving

• 3: resolved

• 4: resolution failed

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

Valores de enumeración:

• TLSv1.1

• TLSv1.2

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

Parameter type.

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.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error