Consulta de características de gateway
Función
Esta API se utiliza para consultar las características de un gateway. Si un gateway no admite las características enumeradas en la siguiente tabla, póngase en contacto con el soporte técnico para actualizar el gateway.
En la siguiente tabla se enumeran las características de el gateway admitidos.
| Nombre de la función | Descripción | Configurable |
|---|---|---|
| lts | Informes de registros de acceso de Shubao | Sí |
| gateway_responses | Respuestas de gateway personalizadas | No |
| ratelimit | Solicitar configuración de límite de regulación | Sí |
| request_body_size | Configuración del tamaño máximo del cuerpo de la solicitud | Sí |
| backend_timeout | Configuración de tiempo de espera de backend máximo | Sí |
| app_token | autenticación de app_token | Sí |
| app_api_key | autenticación de app_api_key | Sí |
| app_basic | autenticación de app_basic | Sí |
| app_secret | autenticación de app_secret | Sí |
| app_jwt | autenticación de app_jwt | Sí |
| public_key | firmas de backend de public_key | Sí |
| backend_token_allow | Permitir que los inquilinos transmitan tokens de forma transparente al backend | Sí |
| sign_basic | Claves de firma básicas | No |
| multi_auth | Autenticación mediante dos factores | No |
| backend_client_certificate | Autenticación bidireccional de backend | Sí |
| ssl_ciphers | Conjuntos de cifrado HTTPS | Sí |
| route | Rutas personalizadas | No |
| cors | Complementos | No |
| real_ip_from_xff | Uso del encabezado X-Forwarded-For para especificar direcciones IP de origen para el control de acceso y la limitación de solicitudes | Sí |
| app_route | Acceso a dirección IP | Sí |
| vpc_name_modifiable | Modificación del nombre del canal de balanceo de carga | Sí |
| default_group_host_trustlist | Acceso al grupo DEFAULT desde direcciones IP que no son direcciones de acceso entrantes de el gateway actual | Sí |
| throttle_strategy | Solicitar políticas de algoritmo de limitación | Sí |
| custom_log | Impresión de encabezados de solicitud personalizados, cadenas de consulta y cookies en registros | Sí |
| real_ip_header_getter | Uso de un encabezado personalizado para obtener direcciones IP de origen | Sí |
| policy_cookie_param | Uso de cookies en las condiciones de la política de backend | Sí |
| app_quota | Cuotas de clientes | No |
| app_acl | Políticas de limitación de solicitudes | No |
| set_resp_headers | Complementos de gestión de encabezados de respuesta | No |
| vpc_backup | Canales de VPC primarios/en espera | No |
| sign_aes | Claves de firma AES | No |
| kafka_log | Adición, eliminación, modificación y consulta de complementos de inserción de registros de Kafka | No |
| backend_retry_count | Configuración de reintentos de backend | No |
| policy_sys_param | Uso de parámetros del sistema en condiciones de política de backend | No |
| breaker | Interruptores | No |
| content_type_configurable | Devolver el tipo de parámetro de solicitud (Content-Type) al consultar API | No |
| rate_limit_plugin | Solicitar complementos de estrangulamiento | No |
| breakerv2 | Interruptores para degradar servicios en caso de sobrecarga | No |
| sm_cipher_type | Cifrado de datos sensibles locales con algoritmos criptográficos comerciales | No |
| algoritmo_limit_de_velocidad | Solicitar conmutación de algoritmo de estrangulación | No |
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/features
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
proyecto_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. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
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 |
Parámetros 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
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
size |
Integer |
Longitud de la lista de recursos devuelta. |
|
total |
Long |
Número de recursos que coinciden con las condiciones de consulta. |
|
features |
Array of FeatureInfo objects |
Lista de características. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID de función. |
|
name |
String |
Nombre de función. Mínimo: 1 Máximo: 64 |
|
enable |
Boolean |
Indica si se debe habilitar la función. |
|
config |
String |
Configuración de parámetros. |
|
instance_id |
String |
ID de gateway. |
|
update_time |
String |
Tiempo de actualización de la función. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 404
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
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
{
"total" : 1,
"size" : 1,
"features" : [ {
"config" : "on",
"enable" : true,
"id" : "db9a9260cd3e4a16a9b5747a65d3ffaa",
"instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
"name" : "app_api_key",
"update_time" : "2020-08-24T01:17:31.041984Z"
} ]
}
Código de estado: 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}
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.3030",
"error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}
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 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.
