调用ModifyProtocolService接口修改指定的协议服务，支持修改协议服务描述信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyProtocolService

接口名称。

固定取值：ModifyProtocolService。
ProtocolServiceId String 是 ptc-123****

协议服务ID。
FileSystemId String 是 cpfs-123****

文件系统ID。
Description String 否 此协议服务的描述信息。

协议服务的描述。

限制：

  • 长度为2~128个英文或中文字符。
  • 必须以大小写字母或中文开头，不能以http://和https://开头。
  • 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。
DryRun Boolean 否 false

是否对此次修改请求执行预检。

预检操作会帮助您检查参数有效性、依赖条件等，并不会实际修改实例，也不会产生费用。

取值：

  • true：发送检查请求，不会修改协议服务。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过，则返回对应错误。如果检查通过，则返回200 HttpCode。
  • false（默认）：发送正常请求，通过检查后直接修改协议服务。
ClientToken String 否 123e4567-e89b-12d3-a456-42665544****

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String 98696EF0-1607-4E9D-B01D-F20930B6****

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyProtocolService
&ProtocolServiceId=ptc-123****
&FileSystemId=cpfs-123****
&Description=此协议服务的描述信息。
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyProtocolServiceResponse>
    <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>
</ModifyProtocolServiceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 指定的vSwitch可用IP不足。
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. 无库存导致无法创建数据流动。

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