调用ModifyProtocolService修改协议服务描述-文件存储 CPFS-阿里云-文件存储 CPFS(CPFS)-阿里云帮助中心

修改一个协议服务，支持修改协议服务描述信息。

接口说明

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

本接口支持修改协议服务描述信息。
协议服务 ID（ProtocolServiceId）获取方式：
- 调用 CreateProtocolService 接口创建协议服务后返回。
- 调用 DescribeProtocolService 接口查询已有协议服务列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:ModifyProtocolService

update

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

无

请求参数

名称	类型	必填	描述	示例值
ProtocolServiceId	string	是	协议服务 ID。调用 CreateProtocolService 接口创建协议服务后返回，或通过 DescribeProtocolService 接口查询获取。	ptc-197ed6a00f2b****
FileSystemId	string	是	文件系统 ID。	cpfs-099394bd928c****
Description	string	否	协议服务的描述信息。限制：长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以 `http://` 和 `https://` 开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。不允许空格及其他特殊字符，合规示例：`My-Protocol-Service_01`。	My-Protocol-Service_01
DryRun	boolean	否	是否对此次修改请求执行预检。预检操作会帮助您检查参数有效性、依赖条件等，并不会实际修改实例，也不会产生费用。取值： true：发送检查请求，不会修改协议服务。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回 200 HttpCode。 false（默认）：发送正常请求，通过检查后直接修改协议服务。	false
ClientToken	string	否	保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。 ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。说明若用户未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	123e4567-e89b-12d3-a456-42665544****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	98696EF0-1607-4E9D-B01D-F20930B6****

示例

正常返回示例

JSON格式

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId参数。
400	MissingProtocolServiceId	ProtocolServiceId is mandatory for this action.	未指定ProtocolServiceId参数。
403	Instance.IncorrectStatus	The specified instance is in an incorrect status.	当前状态不允许操作。
403	InvalidProtocolSpec.NotSupported	The specified protocol spec does not supported.	指定的ProtocolSpec不支持。
403	PermissionDenied.ThroughputInvalid	Standard protocol service should not specified throughput.	通用型协议服务不允许指定服务带宽。
403	InvalidVSwitchId.IpShortage	The specified vswitch ip shortage.
403	OperationDenied.InvalidPtcStatus	The operation is denied due to invalid protocol service status.	当前协议服务状态不支持该操作。
403	OperationDenied.InvalidState	The operation is denied due to invalid file system state.
403	OperationDenied.NotSupported	The operation is denied due to not supported.	文件系统不支持协议机服务。
403	PermissionDenied.CLThroughputInvalid	Throughput of caching protocol service is invalid.	缓存型协议服务带宽无效。
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的文件系统不存在。
404	InvalidProtocolService.NotFound	The specified protocol service does not exist.	指定的协议服务不存在。
404	InvalidDescription.InvalidFormat	Description format is invalid.	指定的描述格式非法。
404	OperationDenied.NoStock	The operation is denied due to no stock.	文件系统无库存。

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

变更历史

更多信息，参考变更详情。