DescribePolarFsQuota - 查询PolarFS配额规则

获取指定PolarFS实例下的全部配额规则信息。

接口说明

请求说明

  • 本 API 用于查询特定 PolarFS 实例下的所有配额规则,支持通过QuotaNameMatchPatternMatch参数进行模糊匹配。

  • 分页功能暂未公开,待内核准备好后将开放使用。目前返回结果无分页限制。

  • PolarFsInstanceId是必填项,用于指定要查询的 PolarFS 实例。

  • 可选参数如QuotaNameMatchPatternMatch等可用于进一步筛选符合条件的配额规则。

  • 返回的数据包括但不限于配额规则总数、当前页规则数量以及具体的规则详情(如规则 ID、名称、描述、容量限制等)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PolarFsInstanceId

string

PolarFs 实例 ID

pfs-2ze0i74ka607*****

DBClusterId

string

集群 ID。

说明

企业、基础、湖仓版:您可以调用 DescribeDBClusters 接口可以查询集群 ID。

pc-**************

RegionId

string

地域 ID。

说明

您可以通过 DescribeRegions 接口查看当前账号下的所有可用地域信息,包括地域 ID。

cn-beijing

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

2FED790E-FB61-4721-8C1C-07C627******

PolarFsInstanceId

string

PolarFs 实例 ID

pfs-2ze0i74ka607*****

PageSize

string

每页记录数,取值:5~50。默认值:10。

10

PageNumber

string

页码。

1

TotalRecordCount

string

总记录数。

5

PageRecordCount

string

本页记录数。

5

PolicyItems

array<object>

规则明细

object

规则

Id

integer

规则 ID

73

Name

string

规则名称

xxxxx

Description

string

规则描述说明

NULL

Include

string

匹配路径的通配模式

  • / 开头的路径模式(支持 *?、**` 的 glob 语法)。

/a*

Exclude

string

排除特定路径的匹配规则

  • / 开头的路径模式(支持 *?** 的 glob 语法)

NULL

SizeLimit

integer

限制目录下文件总容量。单位:GB

  • 说明:不小于 1GB

1

FileCountLimit

integer

目录下用户的文件数目限制。

77

AccessTTL

integer

access time 对应的 ttl,单位 秒

7200

ChangeTTL

integer

change time 对应的 ttl,单位 秒

7200

Priority

integer

配额规则的优先级。

1

Enabled

boolean

规则是否启用,取值如下:

  • true:新增事件对新事物立即生效,默认值

  • false:新增事件对新事物不生效

false

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情