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/ Las API de gateway dedicado (V2)/ Gestión de configuraciones/ Consulta de configuraciones de recursos de un gateway

Actualización más reciente 2023-03-29 GMT+08:00

Ver PDF

Consulta de configuraciones de recursos de un gateway

Función

Esta API se utiliza para consultar las configuraciones de recursos y el uso de un gateway.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
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.

**Tabla 2** Parámetros de Query
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

**Tabla 3** Parámetros de encabezado 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

**Tabla 4** Parámetros de body de respuesta
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.
configs	Array of Config objects	Lista de cuotas.

**Tabla 5** Config
Parámetro	Tipo	Descripción
config_id	String	ID de cuota.
config_name	String	Nombre de cuota. Valores de enumeración: API_NUM_LIMIT APP_NUM_LIMIT APIGROUP_NUM_LIMIT ENVIRONMENT_NUM_LIMIT VARIABLE_NUM_LIMIT SIGN_NUM_LIMIT THROTTLE_NUM_LIMIT APIGROUP_DOMAIN_NUM_LIMIT API_VERSION_NUM_LIMIT VPC_NUM_LIMIT VPC_INSTANCE_NUM_LIMIT API_PARAM_NUM_LIMIT API_USER_CALL_LIMIT ACL_NUM_LIMIT APP_THROTTLE_LIMIT USER_THROTTLE_LIMIT API_NUM_LIMIT_PER_GROUP API_POLICY_NUM_LIMIT API_CONDITION_NUM_LIMIT SL_DOMAIN_CALL_LIMIT ELB_SWITCH AUTHORIZER_NUM_LIMIT AUTHORIZER_IDENTITY_NUM_LIMIT APP_CODE_NUM_LIMIT REGION_MANAGER_WHITELIST_SERVICES API_SWAGGER_NUM_LIMIT API_TAG_NUM_LIMIT LTS_SWITCH APP_KEY_SECRET_SWITCH RESPONSE_NUM_LIMIT CONFIG_NUM_LIMIT_PER_APP BACKEND_TOKEN_ALLOW_SWITCH APP_TOKEN_SWITCH API_DESIGNER_SWITCH APP_API_KEY_SWITCH APP_BASIC_SWITCH APP_JWT_SWITCH APP_ROUTE_SWITCH PUBLIC_KEY_SWITCH APP_SECRET_SWITCH CASCADE_SWITCH IS_INIT_API_PATH_HASH
config_value	String	Valor de cuota. Indica el valor de la cuota para el gateway actual.
config_time	String	Hora en que se crea la cuota.
remark	String	Descripción de cuota. API_NUM_LIMIT: Número máximo de APIs que puede crear. APP_NUM_LIMIT: Número máximo de aplicaciones que puede crear. APIGROUP_NUM_LIMIT: Número máximo de grupos de API que puede crear. ENVIRONMENT_NUM_LIMIT: Número máximo de entornos que puede crear. VARIABLE_NUM_LIMIT: Número máximo de variables de entorno que puede crear para un grupo de API. SIGN_NUM_LIMIT: Número máximo de claves de firma que puede crear. THROTTLE_NUM_LIMIT: Número máximo de políticas de limitación de solicitudes que puede crear. APIGROUP_DOMAIN_NUM_LIMIT: Número máximo de nombres de dominio personalizados que puede enlazar a un grupo de API. API_VERSION_NUM_LIMIT: Número máximo de versiones que puede conservar para una API. VPC_NUM_LIMIT: Número máximo de canales de VPC que puede crear. VPC_INSTANCE_NUM_LIMIT: Número máximo de servidores en la nube que puede asociar a un canal de VPC. API_PARAM_NUM_LIMIT: Número máximo de parámetros que puede configurar para una API. API_USER_CALL_LIMIT: Número máximo de veces que se puede llamar a una API dentro de un período específico. ACL_NUM_LIMIT: Número máximo de políticas de control de acceso que puede crear. APP_THROTTLE_LIMIT: Número máximo de aplicaciones excluidas permitidas para una política de limitación de solicitudes. USER_THROTTLE_LIMIT: Número máximo de inquilinos excluidos permitidos para una política de limitación de solicitudes. API_NUM_LIMIT_PER_GROUP: Número máximo de API que puede crear para un grupo de API. API_POLICY_NUM_LIMIT: Número máximo de backends de políticas que puede configurar para una API. API_CONDITION_NUM_LIMIT: Número máximo de condiciones que puede configurar para un backend de políticas. SL_DOMAIN_CALL_LIMIT: Número máximo de solicitudes que se pueden enviar a un nombre de subdominio dentro de un período específico. ELB_SWITCH: si se activan los canales ELB. AUTHORIZER_NUM_LIMIT: Número máximo de autorizados personalizados que puede crear. AUTHORIZER_IDENTITY_NUM_LIMIT: Número máximo de fuentes de identidad que puede configurar para un autorizador personalizado. APP_CODE_NUM_LIMIT: Número máximo de AppCodes que puede crear para una aplicación. REGION_MANAGER_WHITELIST_SERVICES: Lista blanca de servicios que no son verificados por el gerente de la región. API_SWAGGER_NUM_LIMIT: Número máximo de archivos Swagger que puede enlazar a un grupo de API. API_TAG_NUM_LIMIT: Número máximo de etiquetas que puede configurar para una API. LTS_SWITCH: si se debe habilitar los informes de log de LTS. APP_KEY_SECRET_SWITCH: si se debe habilitar la personalización de AppKey y AppSecret. 1: habilitar; 2: deshabilitar. RESPONSE_NUM_LIMIT: Número máximo de respuestas que puede crear para un grupo de API. CONFIG_NUM_LIMIT_PER_APP: Número máximo de elementos de configuración que puede configurar para una aplicación. BACKEND_TOKEN_ALLOW_SWITCH: Si se permite que los inquilinos transmitan tokens de forma transparente al backend. 1: permitir; 2: no permitir. APP_TOKEN_SWITCH: si se debe habilitar AppTokens. API_DESIGNER_SWITCH: si se debe habilitar el diseñador de API. 1: habilitar; 2: deshabilitar. APP_API_KEY_SWITCH: si se debe habilitar la autenticación APP_API_KEY. APP_BASIC_SWITCH: si se debe habilitar la autenticación APP_BASIC. APP_JWT_SWITCH: si se debe habilitar la autenticación APP_JWT. APP_ROUTE_SWITCH: si se deben habilitar las rutas de la aplicación. PUBLIC_KEY_SWITCH: si se debe habilitar la autenticación de backend PUBLIC_KEY. APP_SECRET_SWITCH: si se debe habilitar la autenticación APP_SECRET. CASCADE_SWITCH: si se habilitan gateways en cascada. IS_INIT_API_PATH_HASH: si se ha realizado el hashing de la ruta de la API.
used	Long	Cuota usada del gateway.

Código de estado: 400

**Tabla 6** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Código de estado: 401

**Tabla 7** Parámetros de body 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 8** Parámetros de body 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 9** Parámetros de body 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 10** Parámetros de body de respuesta
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

{
  "total" : 43,
  "size" : 2,
  "configs" : [ {
    "config_id" : "9",
    "config_name" : "API_VERSION_NUM_LIMIT",
    "config_value" : "10",
    "config_time" : "2019-02-12T19:42:19.914989Z",
    "remark" : "xxx",
    "used" : 0
  }, {
    "config_id" : "8",
    "config_name" : "APIGROUP_DOMAIN_NUM_LIMIT",
    "config_value" : "5",
    "config_time" : "2019-02-12T19:42:19.914989Z",
    "remark" : "xxx",
    "used" : 0
  } ]
}

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	Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de configuraciones

Tema anterior: Gestión de configuraciones

Tema siguiente: Consulta de configuraciones de gateway

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