DescribeMountServices--文件存储 vePFS-火山引擎

文档中心

导航

DescribeMountServices

最近更新时间：2024.06.25 14:48:51首次发布时间：2023.09.07 20:28:37

调用 DescribeMountServices 接口查询挂载服务详情。

请求参数

参数	类型	是否必选	示例值	描述
Filters	Array of MountServiceFilter	否	详情请参见请求示例	挂载服务查询过滤器。
OrderBy	String	否	CreateTimeDesc	挂载服务排序方式，取值说明如下： `CreateTimeDesc`：按照挂载服务的创建时间降序。 `CreateTimeAsc`：按照挂载服务的创建时间降序。 `NameDesc`：按照挂载服务的名称升序。 `NameAsc`：按照挂载服务的名称升序。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数，默认为 10。
PageNumber	Integer	否	1	挂载服务信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。

MountServiceFilter

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Key	String	是	Status	根据特性筛选指定特征的实例。支持筛选的参数如下： `Status`：根据挂载服务状态精确筛选，支持多选，使用英文逗号（,）分割。 `FileSystemId`：根据文件系统 ID 精确筛选。 `MountServiceName`：根据挂载服务名称模糊筛选，不支持多选。 `MountServiceId`：根据挂载服务 ID 精确筛选。
Value	String	是	Running	筛选项目的值。

Key

String

是

Status

根据特性筛选指定特征的实例。支持筛选的参数如下：

Status：根据挂载服务状态精确筛选，支持多选，使用英文逗号（,）分割。
FileSystemId：根据文件系统 ID 精确筛选。
MountServiceName：根据挂载服务名称模糊筛选，不支持多选。
MountServiceId：根据挂载服务 ID 精确筛选。

Value String 是 Running 筛选项目的值。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	2	挂载服务个数。
MountServices	Array of MountService	详情请参见返回示例	挂载点详情。
PageSize	Integer	10	每页记录数。取值为 1~100 间的整数，默认为 10。
PageNumber	Integer	1	挂载服务列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。

MountService

参数	类型	示例值	描述
Nodes	Array of MountServiceManagerNode	详情请参见返回示例	客户端管理节点列表。
VpcId	String	vpc-13fz0iip9nlds3n6nu4fi****	私有网络 ID。
Status	String	Running	挂载服务状态，说明如下： `Creating`：创建中 `CreateError`：创建失败 `Running`：运行中 `Updating`：更新中 `UpdateError`：更新失败 `Deleting`：删除中 `DeleteError`：删除失败 `Deleted`：已删除 `Attaching`：绑定中 `AttachError`：绑定失败 `Detaching`：解绑中 `DetachError`：解绑失败 `Stopped`：关停 `Error`：错误
ZoneId	String	cn-beijing-b	可用区 ID。
Project	String	default	挂载服务所属项目。
RegionId	String	cn-beijing	地域信息。
SubnetId	String	subnet-13fz1bsbrsw743n6nu47c****	子网 ID。
ZoneName	String	华北2（北京）-可用区B	可用区名称。
AccountId	String	210015****	用户 ID。
CreateTime	String	2023-07-18T17:10:03+08:00	创建时间。
MountServiceId	String	mount-94eb****	挂载服务 ID。
SecurityGroupId	String	sg-mioirewk8zcw5smt1ba8****	客户端网卡安全组 ID。
MountServiceName	String	mountservice	挂载服务名称。
AttachFileSystems	Array of AttachFileSystem	详情请参见返回示例	挂载实例信息。

MountServiceManagerNode

参数	类型	示例值	描述
NodeId	String	i-yclmdnskx838df3y****	ECS 实例 ID。
DefaultPassword	String	948E4=9@2Jbq****	ECS 实例初始登录密码。

AttachFileSystem

参数	类型	示例值	描述
Status	String	Attached	绑定状态，说明如下： `Attaching`：绑定中 `AttachError`：绑定失败 `Attached`：已绑定 `Detaching`：解绑中 `DetachError`：解绑失败
AccountId	String	210015****	火山引擎账户 ID。
CustomerPath	String	/vepfs-test	用户挂载路径。
FileSystemId	String	vepfs-cnbjbf3c46b6****	文件系统 ID。
FileSystemName	String	lltest	文件系统名称。

示例

请求示例

POST /?Action=DescribeMountServices&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/vepfs/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z
{
  "OrderBy": "CreateTimeAsc",
  "PageSize": 10,
  "Filters": [
    {
      "Key": "Status",
      "Value": "Running"
    }
  ],
  "PageNumber": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202309031839102729264A568599F0441D",
    "Action": "DescribeMountServices",
    "Version": "2022-01-01",
    "Service": "vepfs",
    "Region": "cn-beijing"
  },
  "Result": {
    "MountServices": [
      {
        "AccountId": "210015****",
        "AttachFileSystems": [
          {
            "AccountId": "210015****",
            "CustomerPath": "/vepfs-test",
            "FileSystemId": "vepfs-cnbjbf3c46b6****",
            "FileSystemName": "lltest",
            "Status": "Attached"
          },
          {
            "AccountId": "210015****",
            "CustomerPath": "/vepfs-cnbj6d33f383****",
            "FileSystemId": "vepfs-cnbj6d33f383****",
            "FileSystemName": "lltest2",
            "Status": "Attached"
          }
        ],
        "CreateTime": "2023-08-14T14:08:22+08:00",
        "MountServiceId": "mount-75a6****",
        "MountServiceName": "lltest",
        "Nodes": [
          {
            "DefaultPassword": "948E4=9@2Jbq****",
            "NodeId": "i-yclmdnskx838df3y****"
          },
          {
            "DefaultPassword": "948E4=9@2Jbq****",
            "NodeId": "i-yclmdnskx938dev3****"
          },
          {
            "DefaultPassword": "948E4=9@2Jbq****",
            "NodeId": "i-yclmdnskxa38deof****"
          }
        ],
        "Project": "default",
        "RegionId": "cn-beijing",
        "SecurityGroupId": "sg-mioirewk8zcw5smt1ba8****",
        "Status": "Running",
        "SubnetId": "subnet-13fz1bsbrsw743n6nu47c****",
        "VpcId": "vpc-13fz0iip9nlds3n6nu4fi****",
        "ZoneId": "cn-beijing-b",
        "ZoneName": "华北2（北京）-可用区B"
      },
      {
        "AccountId": "210015****",
        "CreateTime": "2023-07-03T20:15:13+08:00",
        "MountServiceId": "mount-3bdc****",
        "MountServiceName": "wtest",
        "Nodes": [
          {
            "DefaultPassword": "2^033*5g84f6****",
            "NodeId": "i-ycilsgg6vc5m56c2****"
          },
          {
            "DefaultPassword": "2^033*5g84f6****",
            "NodeId": "i-ycilsgg6vd5m56fo****"
          },
          {
            "DefaultPassword": "2^033*5g84f6****",
            "NodeId": "i-ycilsgg6ve5m5724****"
          }
        ],
        "Project": "default",
        "RegionId": "cn-beijing",
        "SecurityGroupId": "sg-13fqx0f6m6akg3n6nu5up****",
        "Status": "Running",
        "SubnetId": "subnet-13fz1bsbrsw743n6nu47c****",
        "VpcId": "vpc-13fz0iip9nlds3n6nu4fi****",
        "ZoneId": "cn-beijing-b",
        "ZoneName": "华北2（北京）-可用区B"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2
  }
}