DescribePolarFsQuota - PolarDB - Centro de documentación de Alibaba Cloud

Obtiene toda la información de las reglas de cuota de una instancia de Polarlakebase especificada.

Descripción de la operación

Descripción de la solicitud

Esta operación de API consulta todas las reglas de cuota para una instancia específica de Polarlakebase. Puede usar los parámetros QuotaNameMatch y PatternMatch para realizar coincidencias aproximadas.
La función de paginación aún no está disponible públicamente y se lanzará cuando el kernel esté listo. Actualmente, los resultados se devuelven sin límites de paginación.
PolarFsInstanceId es obligatorio y especifica la instancia de Polarlakebase que se va a consultar.
Los parámetros opcionales como QuotaNameMatch y PatternMatch se pueden usar para filtrar aún más las reglas de cuota que cumplen con las condiciones especificadas.
Los datos devueltos incluyen, entre otros, el número total de reglas de cuota, el número de reglas en la página actual y detalles específicos de las reglas como el ID, el nombre, la descripción y los límites de capacidad de la regla.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribePolarFsQuota

none

*Todos los recursos.

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PolarFsInstanceId	string	Sí	El ID de la instancia de Polarlakebase.	pfs-2ze0i74ka607*****
DBClusterId	string	No	El ID del clúster. Nota Enterprise Edition, Basic Edition y Data Lakehouse Edition: Puede llamar a la operación DescribeDBClusters para consultar el ID del clúster.	pc-**************
RegionId	string	No	El ID de la región. Nota Puede llamar a la operación DescribeRegions para consultar todas las regiones disponibles para la cuenta actual, incluidos los ID de región.	cn-beijing
Path	string	No	La ruta de destino.	/data
QuotaType	string	No	El tipo de cuota a consultar. Valores válidos: quota : cuota. quotaPolicy : política de cuota.	quotaPolicy

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	2FED790E-FB61-4721-8C1C-07C627******
PolarFsInstanceId	string	El ID de la instancia de Polarlakebase.	pfs-2ze0i74ka607*****
PageSize	string	El número de registros por página. Valores válidos: de 5 a 50. Valor predeterminado: 10.	10
PageNumber	string	El número de página.	1
TotalRecordCount	string	El número total de registros.	5
PageRecordCount	string	El número de registros en la página actual.	5
PolicyItems	array<object>	Los detalles de las reglas.
	object	La regla.
Id	integer	El ID de la regla.	73
Name	string	El nombre de la regla.	xxxxx
Description	string	La descripción de la regla.	NULL
Include	string	El patrón glob para coincidir con rutas. Un patrón de ruta que comienza con `/` (admite la sintaxis glob ``, `?` y `*`).	/a*
Exclude	string	La regla de coincidencia para excluir rutas específicas. Un patrón de ruta que comienza con `/` (admite la sintaxis glob ``, `?` y `*`).	NULL
SizeLimit	integer	El límite de capacidad total de archivos para el directorio. Unidad: GB. Nota: El valor debe ser de al menos 1 GB.	1
FileCountLimit	integer	El límite de cantidad de archivos para los usuarios en el directorio.	77
AccessTTL	integer	El TTL para el tiempo de acceso. Unidad: segundos.	7200
ChangeTTL	integer	El TTL para el tiempo de cambio. Unidad: segundos.	7200
Priority	integer	La prioridad de la regla de cuota.	1
Enabled	boolean	Especifica si la regla está habilitada. Valores válidos: true: El nuevo evento surte efecto de inmediato para las nuevas transacciones. Este es el valor predeterminado. false: El nuevo evento no surte efecto para las nuevas transacciones.	false
QuotaItems	array<object>	La información de cuota.
	object	La cuota de directorio.
Path	string	La ruta del directorio.	/data
Capacity	integer	La capacidad. Unidad: bytes.	1073741824
UsedCapacity	integer	La capacidad utilizada. Unidad: bytes.	104857600
Inodes	integer	Inodos.	100
UsedInodes	integer	El número de inodos utilizados.	1
Path	string	La ruta del directorio.	/data

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627******",
  "PolarFsInstanceId": "pfs-2ze0i74ka607*****",
  "PageSize": "10",
  "PageNumber": "1",
  "TotalRecordCount": "5",
  "PageRecordCount": "5",
  "PolicyItems": [
    {
      "Id": 73,
      "Name": "xxxxx",
      "Description": "NULL",
      "Include": "/a*",
      "Exclude": "NULL",
      "SizeLimit": 1,
      "FileCountLimit": 77,
      "AccessTTL": 7200,
      "ChangeTTL": 7200,
      "Priority": 1,
      "Enabled": false
    }
  ],
  "QuotaItems": [
    {
      "Path": "/data",
      "Capacity": 1073741824,
      "UsedCapacity": 104857600,
      "Inodes": 100,
      "UsedInodes": 1
    }
  ],
  "Path": "/data"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.