更新时间:2026-09-30 GMT+08:00
分享

查询文件系统类型和配额 - ListShareTypes

功能介绍

查询文件系统类型、文件系统类型的配额、可用区列表等。当前只在部分区域支持。具体的区域列表请参见API概览的接口说明。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/sfs-turbo/share-types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

查询文件系统类型和配额时,每页返回记录数的最大值,用于控制分页大小。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

offset

否

Integer

参数解释:

查询文件系统类型和配额时,分页查询的偏移量,用于指定返回结果的起始位置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权认证。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

是

String

参数解释:

请求消息体MIME类型,用于标识请求正文的数据格式。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表5 响应Body参数

参数

参数类型

描述

share_types

Array of ShareTypeResponseBody objects

参数解释:

文件系统类型和配额信息列表,包含各文件系统类型的名称及对应的配额信息。

取值范围:

不涉及。

表6 ShareTypeResponseBody

参数

参数类型

描述

share_type

String

参数解释:

文件系统类型。

取值范围:

  • standard:表示标准型。

  • standard.enhanced:表示标准型-增强版。

  • performance:表示性能型。

  • performance.enhanced:表示性能型-增强版。

  • hpc.20M:表示20 MB/s/TiB。

  • hpc.40M:表示40 MB/s/TiB。

  • hpc.125M:表示125 MB/s/TiB。

  • hpc.250M:表示250 MB/s/TiB。

  • hpc.500M:表示500 MB/s/TiB。

  • hpc.1000M:表示1000 MB/s/TiB。

  • hpc.cache:表示hpc缓存型。

  • aits.100M:表示100MB/s/TiB-智算型。

  • aits.200M:表示200MB/s/TiB-智算型。

scenario

String

参数解释:

文件系统场景,由系统根据区域架构和部署模式自动判定,用于区分不同云环境下的规格类型。

取值范围:

  • Standard:公有云标准场景。

  • DEC:专属分布式云场景。

attribution

ShareTypesAttribution object

参数解释:

文件系统属性,包含容量、带宽、IOPS、平均单路4K延迟等规格属性。

取值范围:

不涉及。

support_period

Boolean

参数解释:

是否支持包周期计费模式。

取值范围:

  • true:支持包周期计费。

  • false:不支持包周期计费。

available_zones

Array of ShareTypeAvailableZone objects

参数解释:

可用区列表。

取值范围:

不涉及。

spec_code

String

参数解释:

文件系统规格编码。

取值范围:

不涉及。

storage_media

String

参数解释:

存储类型。

取值范围:

  • SAS:标准型默认存储介质,适用于大容量存储场景。

  • SSD:性能型默认存储介质,适用于高并发、低时延场景。

  • ESSD:增强型存储介质,部分局点可选,适用于超高并发、超低时延场景。

features

Array of strings

参数解释:

文件系统类型支持的特性列表。

取值范围:

不涉及。

表7 ShareTypesAttribution

参数

参数类型

描述

capacity

ShareTypesAttributionCapacity object

参数解释:

容量属性,包含最大容量、最小容量和容量梯度。

取值范围:

不涉及。

bandwidth

ShareTypesAttributionBandwidth object

参数解释:

带宽属性,包含最大带宽、最小带宽和带宽梯度。

取值范围:

不涉及。

iops

ShareTypesAttributionIops object

参数解释:

IOPS属性,包含最大IOPS和最小IOPS。

取值范围:

不涉及。

single_channel_4k_latency

ShareTypesAttributionSingleChannel4KLatency object

参数解释:

平均单路4K延迟属性,包含最大值和最小值。

取值范围:

不涉及。

表8 ShareTypesAttributionCapacity

参数

参数类型

描述

max

Integer

参数解释:

该文件系统类型支持的单个文件系统最大容量,单位为GB。

取值范围:

不涉及。

min

Integer

参数解释:

该文件系统类型支持的单个文件系统最小容量,单位为GB。

取值范围:

不涉及。

step

Number

参数解释:

容量梯度,即扩容文件系统时容量变更的最小步长,单位为GB。

取值范围:

不涉及。

表9 ShareTypesAttributionBandwidth

参数

参数类型

描述

max

Integer

参数解释:

该文件系统类型支持的最大带宽,单位为MB/s。

取值范围:

不涉及。

min

Integer

参数解释:

该文件系统类型支持的最小带宽,单位为MB/s。

取值范围:

不涉及。

step

Integer

参数解释:

带宽梯度,即扩容文件系统时带宽变更的最小单位,单位为MB/s。

取值范围:

不涉及。

density

Number

参数解释:

带宽密度,即每TB容量对应的带宽值,单位为MB/s/TiB。

取值范围:

不涉及。

base

Integer

参数解释:

基础带宽,即文件系统的初始带宽值,单位为MB/s。

取值范围:

不涉及。

表10 ShareTypesAttributionIops

参数

参数类型

描述

max

Integer

参数解释:

该文件系统类型支持的最大IOPS,即每秒最大读写操作次数。

取值范围:

不涉及。

min

Integer

参数解释:

该文件系统类型支持的最小IOPS,即每秒最小读写操作次数。

取值范围:

不涉及。

表11 ShareTypesAttributionSingleChannel4KLatency

参数

参数类型

描述

max

Integer

参数解释:

平均单路4K延迟的最大值,单位为ms。

取值范围:

不涉及。

min

Integer

参数解释:

平均单路4K延迟的最大值,单位为ms。

取值范围:

不涉及。

表12 ShareTypeAvailableZone

参数

参数类型

描述

available_zone

String

参数解释:

可用区编码,该文件系统类型支持部署的可用区编码。

取值范围:

不涉及。

status

String

参数解释:

该文件系统类型在对应可用区的售卖状态,标识当前是否可购买。

取值范围:

  • normal:正常售卖,可正常购买。

  • sellout:已售罄,当前可用区资源已售完。

状态码:400

表13 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表14 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

请求示例

无

响应示例

状态码:200

  • 查询当前所支持的文件系统类型和配额。

    {
      "share_types" : [ {
        "share_type" : "standard",
        "scenario" : "Standard",
        "attribution" : {
          "capacity" : {
            "max" : 1048576,
            "min" : 100,
            "step" : 100
          },
          "bandwidth" : {
            "max" : 300,
            "min" : 150,
            "step" : -1,
            "density" : 40.96,
            "base" : 150
          },
          "iops" : {
            "max" : 20000,
            "min" : 1000
          },
          "single_channel_4k_latency" : {
            "max" : 20000,
            "min" : 1000
          }
        },
        "spec_code" : "sfs.turbo.standard",
        "storage_media" : "HDD",
        "support_period" : true,
        "available_zones" : [ {
          "available_zone" : "az1",
          "status" : "normal"
        } ],
        "features" : [ "periodic" ]
      }, {
        "share_type" : "hpc.125M",
        "scenario" : "Standard",
        "attribution" : {
          "capacity" : {
            "max" : 1048576,
            "min" : 512,
            "step" : 1228.8
          },
          "bandwidth" : {
            "max" : 20480,
            "min" : 150,
            "step" : -1,
            "density" : 125,
            "base" : 0
          },
          "iops" : {
            "max" : 1000000,
            "min" : 0
          },
          "single_channel_4k_latency" : {
            "max" : 3,
            "min" : 1
          }
        },
        "spec_code" : "sfs.turbo.standard",
        "storage_media" : "HDD",
        "support_period" : true,
        "available_zones" : [ {
          "available_zone" : "az1",
          "status" : "normal"
        } ],
        "features" : [ "periodic" ]
      } ]
    }

状态码:400

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

状态码

状态码

描述

200

成功

400

错误响应

错误码

请参见错误码。

相关文档