全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询可用存储集群信息

最近更新时间:2025-12-16 17:00:56

1. 接口描述

本接口(DescribeDirQuota)用于查询账号下可用的存储集群信息。

2. 请求方法

GET

3. 请求参数

请求参数包含公共请求参数和接口请求参数。其中,公共请求参数是每个接口都会用到的请求参数,具体参见公共参数及签名机制;接口请求参数是各个接口所特有的,具体参见下方说明:

  1. 请求头

名称

是否必须

Content-Type

application/json

Accept

application/json

  1. 请求体

名称

类型

是否必须

描述

Region

string

查询对应地域下支持的存储池类型,有效值:

  • cn-north-vip1(华北专属1区(天津))

  • cn-beijing-6(华北1(北京))

  • cn-northwest-3(西北3区(宁夏))

  • cn-northwest-4(西北4(海东))

  • cn-shanghai-2(华东1(上海))

  • cn-northwest-1(西北1(庆阳))

  • cn-ningbo-1(华东2(宁波))

AvailZone

string

可用区,需与地域参数配合使用,有效值:

  • cn-north-vip1a

  • cn-beijing-6a

  • cn-beijing-6e

  • cn-northwest-3a

  • cn-northwest-4a

  • cn-shanghai-2d

  • cn-northwest-1a

  • cn-ningbo-1a

StoreClass

string

文件系统存储类型,有效值:

  • KPFS-capacity(容量Ⅰ型)

  • KPFS-capacity2(容量Ⅱ型)

  • KPFS-standard(标准型)

  • KPFS-P-S01(性能Ⅰ型)

  • KPFS-P-S01(性能Ⅱ型)

SRoceCluster

string

存储RoCE集群名称,仅性能Ⅰ型、性能Ⅱ型支持,若传入存储RoCE集群,则返回对应存储RoCE集群下的存储集群信息。

StorePoolType

string

存储池类型。

Action

string

该参数为公共参数,取值:DescribeClusterInfo。

Version

string

该参数为公共参数,取值:2024-09-30。

4. 返回参数

名称

类型

描述

RequestId

string

唯一请求ID,每次请求都会返回。

Data

object[]

存储集群信息。

—Region

string

地域。

—AvailZone

string

可用区。

—StoreClasses

string[]

存储类型。

—StorePoolType

string

存储池类型。

—SRoceCluster

string

存储RoCE集群名称,仅性能Ⅰ型、性能Ⅱ型支持。

—ClusterCode

string

存储池Code,仅性能Ⅰ型、性能Ⅱ型支持,在通过创建文件系统OpenAPI创建性能Ⅰ型、性能Ⅱ型文件系统时需传入该字段。

5. 示例

请求示例

http://kpfs.api.ksyun.com?Region=cn-qingyangtest-1&SRoceCluster=QYYC01-Sroce-Cluster-01&StoreClass=KPFS-P-S01&StorePoolType=KPFS-P2

返回示例

{
    "RequestId": "d8659c83615c47cab734f95cdfcdc34f",
    "Data": [
        {
            "Region": "cn-qingyangtest-1",
            "AvailZone": "cn-qingyangtest-1a",
            "StoreClasses": [
                "KPFS-capacity2",
                "KPFS-standard",
                "KPFS-capacity"
            ],
            "StorePoolType": "KPFS-C1",
            "SRoceCluster": "",
            "ClusterCode": ""
        },
        {
            "Region": "cn-qingyangtest-1",
            "AvailZone": "cn-qingyangtest-1a",
            "StoreClasses": [
                "KPFS-capacity2",
                "KPFS-standard",
                "KPFS-capacity"
            ],
            "StorePoolType": "KPFS-C1",
            "SRoceCluster": "",
            "ClusterCode": ""
        },
        {
            "Region": "cn-qingyangdev-2",
            "AvailZone": "cn-qingyangdev-2a",
            "StoreClasses": [
                "KPFS-capacity2",
                "KPFS-capacity"
            ],
            "StorePoolType": "KPFS-C1",
            "SRoceCluster": "",
            "ClusterCode": ""
        },
        {
            "Region": "cn-qingyangtest-1",
            "AvailZone": "cn-qingyangtest-1a",
            "StoreClasses": [
                "KPFS-capacity2",
                "KPFS-standard",
                "KPFS-capacity"
            ],
            "StorePoolType": "KPFS-C1",
            "SRoceCluster": "",
            "ClusterCode": ""
        },
        {
            "Region": "cn-qingyangtest-1",
            "AvailZone": "cn-qingyangtest-1a",
            "StoreClasses": [
                "KPFS-capacity2",
                "KPFS-standard",
                "KPFS-capacity"
            ],
            "StorePoolType": "KPFS-C2",
            "SRoceCluster": "",
            "ClusterCode": ""
        },
        {
            "Region": "cn-qingyangtest-1",
            "AvailZone": "cn-qingyangtest-1a",
            "StoreClasses": [
                "KPFS-P-S02",
                "KPFS-P-S01"
            ],
            "StorePoolType": "KPFS-P1",
            "SRoceCluster": "QYYC01-Sroce-Cluster-01",
            "ClusterCode": "7c2cd53b-8eec-440d-a450-18b7db2b0040-1"
        },
        {
            "Region": "cn-shanghai-3",
            "AvailZone": "cn-shanghai-3a",
            "StoreClasses": [
                "KPFS-P-S02",
                "KPFS-P-S01"
            ],
            "StorePoolType": "KPFS-P1",
            "SRoceCluster": "QYYC01-Sroce-Cluster-01",
            "ClusterCode": "7c2cd53b-8eec-440d-a450-18b7db2b0040-3"
        },
        {
            "Region": "cn-shanghai-3",
            "AvailZone": "cn-shanghai-3b",
            "StoreClasses": [
                "KPFS-P-S02",
                "KPFS-P-S01"
            ],
            "StorePoolType": "KPFS-P1",
            "SRoceCluster": "QYYC01-Sroce-Cluster-01",
            "ClusterCode": "7c2cd53b-8eec-440d-a450-18b7db2b0040-4"
        },
        {
            "Region": "cn-qingyangtest-1",
            "AvailZone": "cn-qingyangtest-1a",
            "StoreClasses": [
                "KPFS-P-S02",
                "KPFS-P-S01"
            ],
            "StorePoolType": "KPFS-P2",
            "SRoceCluster": "QHDX01-Sroce-Cluster-01",
            "ClusterCode": "123e4567-e89b-12d3-a456-426614174123"
        }
    ]
}

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈