Modelo de objetos

id

String

ID de API

R

-

name

String

Nombre de la API

CRU

Sí

group_id

String

ID del grupo de API al que pertenece la API

CR

Sí

type

Integer

Tipo de API, que puede ser:

• 1: público
• 2 privado

CRU

Sí

status

Integer

Estado de la API, que puede ser:

• 1: enabled
• 2: disabled
• 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión de la API

CRU

No

req_protocol

String

Protocolo de solicitud, que puede ser:

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

Valor predeterminado: HTTPS

CRU

No

req_method

String

Método de solicitud, que puede ser:

• GET
• POST
• PUT
• DELETE
• HEAD
• PATCH
• OPTIONS
• ANY

CRU

Sí

req_uri

String

Dirección de acceso (URI) de la API, excluidos el nombre de dominio, el número de puerto y el protocolo de solicitud

CRU

Sí

auth_type

String

Modo de autenticación de seguridad, que puede ser:

• NONE
• APP
• IAM
• AUTHORIZER

CRU

Sí

authorizer_id

String

ID del autorizador personalizado de frontend

CRU

No

match_mode

String

Modo de coincidencia de rutas, que puede ser:

• SWA: coincidencia de prefijo
• NORMAL: coincidencia exacta

CRU

Sí

arrange_necessary

Integer

Indica si se requiere orquestación. El valor puede ser:

• 1: sí
• 2: no

Valor predeterminado 2

R

-

backend_type

String

Tipo de backend, que puede ser:

• HTTP (web)
• FUNCTION
• MOCK

CRU

Sí

register_time

Timestamp

Hora en que se creó la API

R

-

update_time

Timestamp

Hora de la última modificación de la API

R

-

remark

String

Descripción de la API

CRU

No

tag

String

Etiqueta de API

CRU

No

cors

String

Indica si se admite el uso compartido de recursos entre orígenes (CORS)

• TRUE: soportado
• FALSE: no soportado

Valor predeterminado: FALSE

CRU

No

response_id

String

ID de la respuesta personalizada

CRU

No

id

String

ID de backend de Web

R

-

status

Integer

Estado del backend de web, que puede ser:

• 1: enabled
• 2: disabled
• 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión del backend de web

CRU

No

url_domain

String

Punto de conexión de backend

CRU

Sí

req_protocol

String

Protocolo de solicitud, que puede ser:

• HTTP
• HTTPS

CRU

Sí

req_method

String

Método de solicitud, que puede ser:

• GET
• POST
• PUT
• DELETE
• HEAD
• PATCH
• OPTIONS
• ANY

CRU

Sí

req_uri

String

Dirección de acceso (URI) del backend de web

CRU

Sí

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

Sí

front_api_id

String

ID de API

R

-

register_time

Timestamp

Tiempo de creación

R

-

update_time

Timestamp

Hora en la que se modificó por última vez el backend de web

R

-

remark

String

Descripción del backend de web

CRU

No

vpc_status

Integer

Indica si se debe utilizar un canal de VPC. El valor puede ser:

• 1: sí
• 2: no

CRU

No. No se utiliza ningún canal de VPC por defecto.

vpc_info

String

Información del canal de VPC

CRU

No

Este parámetro solo es necesario cuando vpc_status se establece en 1.

authorizer_id

String

ID del autorizador personalizado de backend

CRU

No

id

String

ID de backend de simulacro

R

-

front_api_id

String

ID de API

R

-

status

Integer

Estado del backend de simulacro, que puede ser:

• 1: enabled
• 2: disabled
• 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión del backend de simulacro

CRU

No

result_content

String

Respuesta de simulacro

CRU

No

register_time

Timestamp

Tiempo de creación

R

-

update_time

Timestamp

Hora en la que el backend de simulacro fue modificado por última vez

R

-

remark

String

Descripción del backend de simulacro

CRU

No

id

String

ID de la función

R

-

front_api_id

String

ID de API

R

-

status

Integer

Estado de la función, que puede ser:

• 1: enabled
• 2: disabled
• 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión de la función

CRU

No

function_urn

String

Función URN

CRU

Sí

invocation_type

String

Modo de invocación, que puede ser async o sync

CRU

Sí

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

Sí

register_time

Date

Tiempo de creación

R

-

update_time

Date

Hora en la que la función fue modificada por última vez

R

-

remark

String

Descripción de la función

CRU

No

id

String

ID del parámetro

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre del parámetro

CRU

Yes

type

String

Tipo de parámetro, que puede ser:

• string
• number

CRU

Yes

location

String

Ubicación del parámetro, que puede ser:

• PATH
• QUERY
• HEADER
• FORMDATA

CRU

Sí

default_value

String

Valor predeterminado

CRU

No

sample_value

String

Valor de ejemplo

CRU

No

required

Integer

Si el parámetro es obligatorio

• 1: sí
• 2: no

CRU

Sí

valid_enable

Integer

Si la comprobación de validez está activada

• 1: sí
• 2: no

CRU

Sí

remark

String

Descripción de parámetro

CRU

No

enumerations

String

Valor enumerado

CRU

No

min_num

String

Valor mínimo

CRU

No

max_num

String

Valor máximo

CRU

No

min_size

Integer

Longitud mínima

CRU

No

max_size

Integer

Longitud máxima

CRU

No

regular

String

Regla de verificación regular (actualmente no soportada)

CRU

No

json_schema

String

Regla de verificación de JSON (actualmente no soportada)

CRU

No

id

String

ID del parámetro

R

-

front_api_id

String

ID de API

R

-

req_param_id

String

ID del parámetro de solicitud al que se asigna el parámetro de backend

R

-

name

String

Nombre del parámetro

CRU

Sí

location

String

Ubicación del parámetro, que puede ser:

• PATH
• QUERY
• HEADER
• FORMDATA

CRU

Sí

origin

String

Tipo de parámetro, que puede ser:

• REQUEST
• CONSTANT
• SYSTEM

CRU

Sí

value

String

Valor del parámetro

• Si origin se establece en REQUEST, el valor es el nombre del parámetro de solicitud.
• Si origin se establece en SYSTEM el valor es el nombre del parámetro de gateway.
• Si origin se establece en CONSTANT, el valor es el valor real del parámetro backend.

CRU

No

remark

String

Descripción de parámetro

CRU

No

policy_id

String

ID de la condición de política asociada

CRU

No

id

String

ID de backend

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre de backend

CRU

Sí

url_domain

String

Punto de conexión de backend

CRU

Sí

req_protocol

String

Protocolo de solicitud, que puede ser:

• HTTP
• HTTPS

CRU

Sí

req_method

String

Método de solicitud, que puede ser:

• GET
• POST
• PUT
• DELETE
• HEAD
• PATCH
• OPTIONS
• ANY

CRU

Sí

req_uri

String

Dirección de acceso (URI) del backend de web

CRU

Sí

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

No

vpc_status

Integer

Indica si se debe utilizar un canal de VPC. El valor puede ser:

• 1: sí
• 2: no

CRU

No. No se utiliza ningún canal de VPC por defecto.

vpc_info

String

Información del canal de VPC

CRU

No

Este parámetro solo es necesario cuando vpc_status se establece en 1.

effect_mode

String

Modo efectivo de la política de backend

• ALL
• ANY

CRU

Sí

id

String

ID de backend

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre de backend

CRU

Sí

result_content

String

Respuesta de simulacro

CRU

No

effect_mode

String

Modo efectivo de la política de backend

• ALL
• ANY

CRU

Sí

id

String

ID de backend

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre de backend

CRU

Sí

version

String

Versión de la función

CRU

No

function_urn

String

Función URN

CRU

Sí

invocation_type

String

Invocation mode, which can be async or sync

CRU

Yes

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

Sí

effect_mode

String

Modo efectivo de la política de backend

• ALL
• ANY

CRU

Sí

id

String

ID de condición de política de backend

R

-

condition_type

String

Tipo de condición. Opciones:

• exact: Coincidencia exacta
• enum: Enumeración
• pattern: expresión regular

CRU

No

condition_value

String

Valor de la condición

CRU

Sí

condition_origin

String

Fuente de condición. Opciones:

• param: parámetro de entrada
• source: Dirección IP de origen

CRU

Sí

req_param_id

String

ID de parámetro de entrada

R

-

policy_backend_id

String

ID de política de backend

CRU

Sí

app_code_auth_type

String

Indica si la autenticación AppCode está habilitada. Este parámetro solo es válido cuando 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.

CRU

-