Skip to Content
文件存储 UFS获取文件系统列表 - DescribeUFSVolume2

获取文件系统列表 - DescribeUFSVolume2

简介

获取文件系统列表

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeUFSVolume2Yes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表No
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
VolumeIdstring文件系统IDNo
Offsetint文件列表起始No
Limitint文件列表长度No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
TotalCountint文件系统总数Yes
DataSetarray[UFSVolumeInfo2]文件系统详细信息列表Yes

数据模型

UFSVolumeInfo2

字段名类型描述信息必填
VolumeNamestring文件系统名称Yes
VolumeIdstring文件系统IDYes
TotalMountPointNumint当前文件系统已创建的挂载点数目Yes
MaxMountPointNumint文件系统允许创建的最大挂载点数目Yes
StorageTypestring文件系统存储类型，枚举值，Basic表示容量型，Advanced表示性能型Yes
ProtocolTypestring文件系统协议，枚举值，NFSv3表示NFS V3协议，NFSv4表示NFS V4协议Yes
Remarkstring文件系统备注信息No
Tagstring文件系统所属业务组No
CreateTimeint文件系统创建时间（unix时间戳）No
ExpiredTimeint文件系统过期时间（unix时间戳）No
Sizeint文件系统大小，单位GBNo
UsedSizeint文件系统当前使用容量，单位GBNo
IsExpiredstring是否过期No

示例

请求示例

https://api.tnqacloud.com/?Action=DescribeUFSVolume2
&Region=cn-zj
&ProjectId=DJpEkpgc
&VolumeId=lhwAtBELNnFFCCtnAZauZUyulVgLTOpIBFF
&Offset=9
&Limit=501
&Zone=cn-zj-01

响应示例

{
  "Action": "DescribeUFSVolume2Response",
  "DataSet": [
    {
      "CreateTime": 8,
      "ExpiredTime": 2,
      "IsExpired": "Yes",
      "MaxMountPointNum": 5,
      "ProtocolType": "NFSv4",
      "Remark": "PQJgSJOQ",
      "Size": 9,
      "StorageType": "Advanced",
      "Tag": "wVoXCOhQ",
      "TotalMountPointNum": 1,
      "UsedSize": 1,
      "VolumeId": "BCUKqVILayBIohkHvMFJcXAukkUgqZMflxt",
      "VolumeName": "qoXVyiHKLrARIxnISVeCmWRTxNCRqkLzfUR"
    },
    {
      "CreateTime": 2,
      "ExpiredTime": 4,
      "IsExpired": "Yes",
      "MaxMountPointNum": 5,
      "ProtocolType": "NFSv4",
      "Remark": "GXBqIxLc",
      "Size": 9,
      "StorageType": "Advanced",
      "Tag": "sxtcHxsh",
      "TotalMountPointNum": 1,
      "UsedSize": 1,
      "VolumeId": "ZxaoxhfYQpkFkQWbHCNEDgBeFjBUcOuRuMH",
      "VolumeName": "pYuTTcTGCFkHYOvfgkMVygwakxSnUPQdcEY"
    },
    {
      "CreateTime": 8,
      "ExpiredTime": 8,
      "IsExpired": "Yes",
      "MaxMountPointNum": 5,
      "ProtocolType": "NFSv4",
      "Remark": "SYHlTMuO",
      "Size": 5,
      "StorageType": "Advanced",
      "Tag": "XJUPznAp",
      "TotalMountPointNum": 1,
      "UsedSize": 1,
      "VolumeId": "AUFUveZpdYaXsFzzHsBhjNsKyweRXxDxfFh",
      "VolumeName": "LCtDHYigQPztASQNomZHEJliBWpEYgjWNrc"
    }
  ],
  "RetCode": 0,
  "TotalCount": 3
}
创建文件系统 - CreateUFSVolume获取文件系统挂载点信息 - DescribeUFSVolumeMountpoint