GPU API 接口

查询云存储Pro

接口说明

查询当前账号、项目下未删除的云存储Pro（CFS），返回容量、计费方式、到期时间和挂载实例。传入 CfsId 查询单份存储；不传则查询列表，可通过 Zone 筛选可用区。

POSThttps://api.compshare.cnActionDescribeCFS

查询行为

列表查询按当前账号和项目返回数据，没有 Limit、Offset 分页参数。
Region、Zone 均非必填。可用区筛选使用 Zone；不要将只传 Region 理解为按地域筛选。
传 CfsId 时会校验资源归属。资源无权限或不存在时可能直接报错，不保证统一返回 Found=false。
MountStatus=Mounted 表示仍有未删除的实例保留挂载关系，即使实例已停止也可能是 Mounted，不代表实例当前正在运行。

请求参数

名称	类型	必填	描述	示例值
Action	String	是	接口名称	`DescribeCFS`
Region	String	否	地域；指定 Zone 时传入对应地域，本接口不单独按 Region 筛选	`cn-bj2`
Zone	String	否	可用区筛选条件，不传则不限制可用区	`cn-bj2-03`
ProjectId	String	否	项目 ID，不传使用账号默认项目	`org-xxx`
CfsId	String	否	云存储 ID，不传时查询列表	`cfs-xxxx`

响应参数

名称	类型	描述
Action	String	响应名称：`DescribeCFSResponse`
RetCode	Integer	返回码，0 为成功
Message	String	错误信息，无错误时可能省略
request_uuid	String	请求唯一标识
TotalCount	Integer	本次查询的记录数，为 0 时可能省略
CFSSet	Array of Object	云存储列表，元素结构见下表；为空时可能省略
Found	Boolean	单条查询是否找到活跃记录；列表查询时该顶层字段保持 false，不能用它判断列表是否为空
CfsId	String	单条查询的云存储 ID
Name	String	单条查询的展示名称
ZoneId	Integer	单条查询的数字可用区 ID
Size	Integer	单条查询的容量，单位 GiB
ChargeType	String	单条查询的计费方式
PurchaseValue	Integer	单条查询的到期时间，Unix 秒级时间戳
TopOrganizationId	Integer	单条查询的账号组织 ID
OrganizationId	Integer	单条查询的项目组织 ID
CreateTime	Integer	单条查询的创建时间，Unix 秒级时间戳
UpdateTime	Integer	单条查询的更新时间，Unix 秒级时间戳
MountStatus	String	单条查询的挂载状态
MountedUHostIds	Array of String	单条查询的挂载实例 ID 列表

指定 CfsId 且找到记录时，除 CFSSet[0] 外还会在顶层返回同一份存储的字段。未赋值的可选字段可能省略；例如没有挂载时，MountedUHostIds 可能不返回。

CFSSet 元素结构

名称	类型	描述
CfsId	String	云存储 ID
Found	Boolean	是否存在活跃记录，列表中的记录为 true
Name	String	展示名称
ZoneId	Integer	可用区数字 ID，不是请求中的 Zone 名称
Size	Integer	容量，单位 GiB
ChargeType	String	计费方式，可能为 Month、Year、Day、Dynamic、Postpay；新购不支持 Postpay
PurchaseValue	Integer	到期时间，Unix 秒级时间戳；未获取到时可能省略
TopOrganizationId	Integer	所属账号组织 ID
OrganizationId	Integer	所属项目组织 ID
CreateTime	Integer	创建时间，Unix 秒级时间戳
UpdateTime	Integer	更新时间，Unix 秒级时间戳
MountStatus	String	Mounted：仍有挂载实例；Unmounted：无挂载实例；状态未获取到时可能省略
MountedUHostIds	Array of String	仍挂载该存储的未删除 Pod 实例 ID；无挂载时可能省略

请求示例

查询指定可用区的列表


{
  "Action": "DescribeCFS",
  "Region": "cn-bj2",
  "Zone": "cn-bj2-03"
}

查询单份存储


{
  "Action": "DescribeCFS",
  "CfsId": "cfs-xxxx"
}

响应示例

列表查询示例，顶层 Found=false 不影响 CFSSet 中的查询结果：


{
  "Action": "DescribeCFSResponse",
  "RetCode": 0,
  "request_uuid": "request-xxxx",
  "TotalCount": 1,
  "Found": false,
  "CFSSet": [
    {
      "CfsId": "cfs-xxxx",
      "Found": true,
      "Name": "my-cfs",
      "ZoneId": 5001,
      "Size": 100,
      "ChargeType": "Month",
      "PurchaseValue": 1792195200,
      "TopOrganizationId": 12345,
      "OrganizationId": 67890,
      "CreateTime": 1789603200,
      "UpdateTime": 1789603200,
      "MountStatus": "Mounted",
      "MountedUHostIds": ["cpod-xxxx", "cpod-yyyy"]
    }
  ]
}

空列表可能只返回公共字段及 Found=false，调用方应将缺省的 CFSSet 和 TotalCount 分别视为空列表和 0。