Consulta de configuraciones de gateway
Función
Esta API se utiliza para consultar las configuraciones de gateway.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /v2/{project_id}/apigw/instance/configs
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
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. |
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 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. |
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. |
configs | Array of InstanceConfig objects | Lista de cuotas. |
Parámetro | Tipo | Descripción |
|---|---|---|
config_id | String | ID de cuota. |
config_name | String | Nombre de cuota. |
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.
|
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: 500
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Mensaje de error. |
Ejemplo de las solicitudes
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"total" : 1,
"size" : 1,
"configs" : [ {
"config_id" : "1",
"config_name" : "INSTANCE_NUM_LIMIT",
"config_value" : "5",
"config_time" : 1597981093255,
"remark" : "xxx"
} ]
} Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
} Código de estado: 401
Sin autorización
{
"error_code" : "APIC.7102",
"error_msg" : "Incorrect token or token resolution failed"
} Código de estado: 403
Prohibido
{
"error_code" : "APIC.7106",
"error_msg" : "No permissions to request for the method"
} Código de estado: 500
Error del servidor interno
{
"error_code" : "APIC.9000",
"error_msg" : "Failed to request internal service"
} Códigos de estado
Código de estado | Descripción |
|---|---|
200 | Aceptar |
400 | Error en la solicitud |
401 | Sin autorización |
403 | Prohibido |
500 | Error del servidor interno |
Códigos de error
Consulte Códigos de error.
