PolarFS Quota Rules Overview via DescribePolarFsQuota - PolarDB - Alibaba Cloud - PolarDB

Retrieves all quota rule information for a specified Polarlakebase instance.

Operation description

Request description

This API operation queries all quota rules for a specific Polarlakebase instance. You can use the QuotaNameMatch and PatternMatch parameters for fuzzy matching.
The pagination feature is not yet publicly available and will be released after the kernel is ready. Currently, results are returned without pagination limits.
PolarFsInstanceId is required and specifies the Polarlakebase instance to query.
Optional parameters such as QuotaNameMatch and PatternMatch can be used to further filter quota rules that meet the specified conditions.
The returned data includes but is not limited to the total number of quota rules, the number of rules on the current page, and specific rule details such as rule ID, name, description, and capacity limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribePolarFsQuota

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PolarFsInstanceId	string	Yes	The Polarlakebase instance ID.	pfs-2ze0i74ka607*****
DBClusterId	string	No	The cluster ID. Note Enterprise Edition, Basic Edition, and Data Lakehouse Edition: You can call the DescribeDBClusters operation to query the cluster ID.	pc-**************
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query all available regions for the current account, including region IDs.	cn-beijing
Path	string	No	The target path.	/data
QuotaType	string	No	The quota type to query. Valid values: quota : quota. quotaPolicy : quota policy.	quotaPolicy

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	2FED790E-FB61-4721-8C1C-07C627******
PolarFsInstanceId	string	The Polarlakebase instance ID.	pfs-2ze0i74ka607*****
PageSize	string	The number of records per page. Valid values: 5 to 50. Default value: 10.	10
PageNumber	string	The page number.	1
TotalRecordCount	string	The total number of records.	5
PageRecordCount	string	The number of records on the current page.	5
PolicyItems	array<object>	The rule details.
	object	The rule.
Id	integer	The rule ID.	73
Name	string	The rule name.	xxxxx
Description	string	The rule description.	NULL
Include	string	The glob pattern for matching paths. A path pattern that starts with `/` (supports ``, `?`, and `*` glob syntax).	/a*
Exclude	string	The matching rule for excluding specific paths. A path pattern that starts with `/` (supports ``, `?`, and `*` glob syntax).	NULL
SizeLimit	integer	The total file capacity limit for the directory. Unit: GB. Note: The value must be at least 1 GB.	1
FileCountLimit	integer	The file count limit for users in the directory.	77
AccessTTL	integer	The TTL for access time. Unit: seconds.	7200
ChangeTTL	integer	The TTL for change time. Unit: seconds.	7200
Priority	integer	The priority of the quota rule.	1
Enabled	boolean	Specifies whether the rule is enabled. Valid values: true: The new event takes effect immediately for new transactions. This is the default value. false: The new event does not take effect for new transactions.	false
QuotaItems	array<object>	The quota information.
	object	The directory quota.
Path	string	The directory path.	/data
Capacity	integer	The capacity. Unit: bytes.	1073741824
UsedCapacity	integer	The used capacity. Unit: bytes.	104857600
Inodes	integer	Inodes	100
UsedInodes	integer	The number of used inodes.	1
Path	string	The directory path.	/data

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.