DescribeProtocolService_文件存储(NAS/CPFS)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

该接口仅适用于中国站 CPFS 文件系统。

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
nas:DescribeProtocolService
List
FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

请求参数

字段名称字段详情
ProtocolServiceIdsstring

协议服务 ID。展开详情

示例值:ptc-197ed6a00f2b****,ptc-196ed6a00f2b****参考取值来源:
    CreateProtocolService
    DescribeProtocolMountTarget
Statusstring

按照协议服务的状态作匹配。展开详情

示例值:Running,Updating
NextTokenstring

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

示例值:aBcdg==枚举值:
MaxResultsinteger<int64>

每次查询结果的个数限制。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:20取值 <= 100
FileSystemIdstring

文件系统 ID。

示例值:cpfs-099394bd928c****枚举值:参考取值来源:
    CreateFileSystem
    DescribeFileSystems
    SetFilesetQuota
Descriptionstring

协议服务的描述或描述的一部分作匹配。展开详情

示例值:此协议服务的描述字符长度 <= 128字符长度 >= 2
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同的请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性展开详情

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E字符长度 <= 64字符长度 >= 1

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NextTokenstring

用户继续查询剩余协议服务的 Marker。

示例值:aBcdeg==
ProtocolServicesarray<object>

协议机服务信息列表。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
MissingFileSystemId
FileSystemId is mandatory for this action.诊断
400
InvalidParam.TooManyProtocolServiceIds
Too many protocol service ids given.诊断
403
InvalidStatus.NotSupported
The specified protocol service status does not support.诊断
404
InvalidFileSystem.NotFound
The specified file system does not exist.诊断
404
InvalidParameter.InvalidNextToken
The specified NextToken is invaild.诊断
404
InvalidParameter.InvalidMaxResults
The specified MaxResults is invalid.诊断

变更历史

变更时间变更内容概要操作
2022-04-28
新增OpenAPI,查询协议服务信息

相关示例