CheckPolarFsQuotaConsistency

Updated at:
Copy as MD

Checks the consistency of quota settings in a PolarFS instance.

Operation description

Description

This operation verifies the consistency of quota configurations within a specified PolarFS instance. These configurations include storage capacity and inode limits on directory paths. If inconsistencies are found, the operation returns a list of the inconsistent paths and any related error information.

Usage notes

  • Ensure that the PolarFsInstanceId parameter correctly identifies the target PolarFS instance.

  • When the system detects quota inconsistencies, it returns IsConsistent=false and populates the InconsistentPaths array.

  • If the request is successful and no inconsistencies are found, the InconsistentPaths array is empty and IsConsistent is set to true.

  • For errors such as insufficient permissions or a non-existent resource, see the error codes for details.

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:CheckPolarFsQuotaConsistency

none

*All Resource

*

None None

Request syntax

GET / HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

PolarFsInstanceId

string

Yes

The ID of the PolarFS instance.

pfs-test****

Path

string

No

The directory path.

/test

EnableRepair

boolean

No

Specifies whether to repair an inconsistent quota. Valid values:

  • false

  • true

false

EnableStrictCalculate

boolean

No

Specifies whether to calculate the total usage of the directory in strict mode. Valid values:

  • false

  • true

false

Response elements

Element

Type

Description

Example

object

The response object for the quota consistency check.

PolarFsInstanceId

string

The ID of the PolarFS instance.

pfs-2ze0i74ka607*****

QuotaItem

object

An object that contains details about the quota.

Path

string

The directory path.

/zookeepertest718

Capacity

integer

The storage capacity quota.

104857600

UsedCapacity

integer

The used capacity, in bytes.

104857600

Inodes

integer

The inode quota.

50000

UsedInodes

integer

The number of used inodes.

1

RequestId

string

The request ID.

E56531A4-E552-40BA-9C58-137B80******

Examples

Success response

JSON format

{
  "PolarFsInstanceId": "pfs-2ze0i74ka607*****",
  "QuotaItem": {
    "Path": "/zookeepertest718",
    "Capacity": 104857600,
    "UsedCapacity": 104857600,
    "Inodes": 50000,
    "UsedInodes": 1
  },
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.