GetProtocolMountTarget - 查询协议服务导出目录信息

更新时间:
复制 MD 格式

查询协议服务导出目录信息。

接口说明

查询协议服务导出目录信息。

使用前提

调用本接口前,需确保以下三层资源模型中的每个依赖资源都已存在:

  1. 文件系统(FileSystem):调用 DescribeFileSystems 获取 FileSystemId。

  2. 协议服务(ProtocolService):调用 DescribeProtocolService 获取 ProtocolServiceId,或调用 CreateProtocolService 创建。

  3. 导出目录(ProtocolMountTarget):调用 CreateProtocolMountTarget 创建获取 ExportId,或调用 DescribeProtocolMountTarget 查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:GetProtocolMountTarget

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

NextToken

string

当请求的返回结果被截断时,您可以使用 NextToken 再次发起请求,获取从当前截断位置之后的内容。

M18xMA==

MaxResults

integer

每次查询结果的个数。

取值范围:10~100。默认值:20。

20

FileSystemId

string

文件系统 ID。

  • CPFS:必须以cpfs-开头,例如 cpfs-125487****。

  • CPFS 智算版:必须以bmcpfs-开头,例如 bmcpfs-0015****。

  • CPFS SE:必须以cpfsse-开头,例如 cpfsse-022c71b134****。

cpfs-099394bd928c****

ClientToken

string

保证请求幂等性,从您的客户端生成一个参数值,确保不同请求间该参数值唯一。

ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

说明

若用户未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。

123e4567-e89b-12d3-a456-42665544****

ProtocolServiceId

string

协议服务 ID。必填参数

获取方式:调用 DescribeProtocolService 接口查询协议服务列表,从返回值中获取 ProtocolServiceId。

ptc-197ed6a00f2b****

ExportId

string

协议服务导出目录 ID。必填参数

获取方式

exp-19abf5beab8d****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

6299428C-3861-435D-AE54-9B330A00****

NextToken

string

当请求的返回结果被截断时,您可以使用 NextToken 再次发起请求,获取从当前截断位置之后的内容。

M18xMA==

ProtocolMountTarget

object

协议服务导出目录信息

ExportId

string

导出目录 ID。

exp-19abf5beab8d****

ProtocolMountTargetDomain

string

协议服务导出目录的域名。

cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com

ProtocolType

string

文件系统协议类型。

包括:

  • NFS:NFS 文件协议

  • SMB:SMB 文件协议

  • cpfs:CPFS 文件系统支持的协议类型

NFS

VpcId

string

协议服务导出的专有网络 ID。

vpc-bp1h5mxoqfuo3xurf****

VSwitchId

string

协议服务导出的交换机 ID。

vsw-8vb2qjnxs6hiobzve****

VSwitchIds

array

协议服务导出的交换机 ID 列表。

string

协议服务导出的交换机 ID。

vsw-bp1q3ro8erikjjrb2****

FsetId

string

Fileset ID。

fset-299b4ca04de8****

Path

string

查询到的 CPFS 目录的路径。

格式:

  • 长度为 1~1024 个字符。

  • 使用 UTF-8 编码。

  • 必须以正斜线(/)开头和结尾,根目录为/

/

AccessGroupName

string

权限组名称。

默认权限组:DEFAULT_VPC_GROUP_NAME

DEFAULT_VPC_GROUP_NAME

CreateTime

string

创建时间。 返回格式:yyyy-MM-dd HH:mm:ss

2025-12-22 17:49:25

Status

string

协议服务导出目录的状态。包括:

  • CREATING:创建中。

  • AVAILABLE :可用。

  • MODIFYING:修改中。

  • DELETING:删除中。

  • STOPPING:停止中。

AVAILABLE

Description

string

协议服务导出的描述。

此协议服务导出的描述。

示例

正常返回示例

JSON格式

{
  "RequestId": "6299428C-3861-435D-AE54-9B330A00****",
  "NextToken": "M18xMA==",
  "ProtocolMountTarget": {
    "ExportId": "exp-19abf5beab8d****",
    "ProtocolMountTargetDomain": "cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com",
    "ProtocolType": "NFS",
    "VpcId": "vpc-bp1h5mxoqfuo3xurf****",
    "VSwitchId": "vsw-8vb2qjnxs6hiobzve****",
    "VSwitchIds": [
      "vsw-bp1q3ro8erikjjrb2****"
    ],
    "FsetId": "fset-299b4ca04de8****",
    "Path": "/",
    "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
    "CreateTime": "2025-12-22 17:49:25",
    "Status": "AVAILABLE",
    "Description": "此协议服务导出的描述。"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 MissingFileSystemId FileSystemId is mandatory for this action. 未指定FileSystemId参数。
400 MissingExportId ExportId is mandatory for this action. 未指定ExportId参数。
404 InvalidFileSystem.NotFound The specified file system does not exist. 指定的文件系统不存在。
404 Resource.NotFound The specified resource does not exist. 指定的资源不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情