Consulta de cuotas de credenciales
Función
Esta API se utiliza para consultar cuotas de credenciales. Se soporta la consulta difusa por nombre.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas
|
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. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de 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 |
|
name |
No |
String |
Nombre de cuota de credenciales. |
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. |
|
quotas |
Array of AppQuotaInfo objects |
Cuotas de credenciales. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
app_quota_id |
String |
ID de cuota de credenciales. |
|
name |
String |
Nombre de cuota. Ingrese de 3 a 255 caracteres, comenzando con una letra. Solo se permiten letras, dígitos y guiones bajos (_). |
|
call_limits |
Integer |
Número máximo de veces que se puede invocar a una cuota de credenciales. |
|
time_unit |
String |
Unidad de tiempo. Las opciones son SECOND, MINUTE, HOUR y DAY. |
|
time_interval |
Integer |
Límite de tiempo de una cuota. |
|
remark |
String |
Descripción del parámetro. Máximo: 255 |
|
reset_time |
String |
Hora en la que se restablece la cuota por primera vez. Si no se especifica este parámetro, la hora se calcula en función de la primera hora de invocación de forma predeterminada. |
|
create_time |
String |
Tiempo de creación. |
|
bound_app_num |
Integer |
Número de aplicaciones vinculadas a la política de cuota. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Descripción de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Descripción de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Descripción de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Descripción de error. |
Ejemplo de las solicitudes
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"total" : 1,
"size" : 1,
"quotas" : [ {
"app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3",
"call_limits" : 1000,
"create_time" : "2020-09-19T07:27:47Z",
"name" : "ClientQuota_demo",
"reset_time" : "2020-09-20 00:00:00 +0000 +0000",
"time_interval" : 1,
"time_unit" : "DAY"
} ]
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
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.