ModifyProtocolService - 修改协议服务

更新时间:

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:ModifyProtocolServiceupdate
*FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

请求参数

名称类型必填描述示例值
ProtocolServiceIdstring

协议服务 ID。

ptc-197ed6a00f2b****
FileSystemIdstring

文件系统 ID。

cpfs-099394bd928c****
Descriptionstring

协议服务的描述。

限制:

  • 长度为 2~128 个英文或中文字符。
  • 必须以大小写字母或中文开头,不能以http://https://开头。
  • 可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。
此协议服务的描述信息
DryRunboolean

是否对此次修改请求执行预检。 预检操作会帮助您检查参数有效性、依赖条件等,并不会实际修改实例,也不会产生费用。

取值:

  • true:发送检查请求,不会修改协议服务。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过,则返回对应错误。如果检查通过,则返回 200 HttpCode。
  • false(默认):发送正常请求,通过检查后直接修改协议服务。
false
ClientTokenstring

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

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

说明 若用户未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-42665544****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

98696EF0-1607-4E9D-B01D-F20930B6****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400MissingFileSystemIdFileSystemId is mandatory for this action.未指定FileSystemId参数。
400MissingProtocolServiceIdProtocolServiceId is mandatory for this action.未指定ProtocolServiceId参数。
403Instance.IncorrectStatusThe specified instance is in an incorrect status.当前状态不允许操作。
403InvalidProtocolSpec.NotSupportedThe specified protocol spec does not supported.指定的ProtocolSpec不支持。
403PermissionDenied.ThroughputInvalidStandard protocol service should not specified throughput.通用型协议服务不允许指定服务带宽。
403InvalidVSwitchId.IpShortageThe specified vswitch ip shortage.指定的vSwitch可用IP不足。
403OperationDenied.InvalidPtcStatusThe operation is denied due to invalid protocol service status.当前协议服务状态不支持该操作。
403OperationDenied.InvalidStateThe operation is denied due to invalid file system state.当前文件系统状态不支持该操作。
403OperationDenied.NotSupportedThe operation is denied due to not supported.文件系统不支持协议机服务。
403PermissionDenied.CLThroughputInvalidThroughput of caching protocol service is invalid.缓存型协议服务带宽无效。
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
404InvalidProtocolService.NotFoundThe specified protocol service does not exist.指定的协议服务不存在。
404InvalidDescription.InvalidFormatDescription format is invalid.指定的描述格式非法。
404OperationDenied.NoStockThe operation is denied due to no stock.文件系统无库存。

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

变更历史

变更时间变更内容概要操作
2024-09-05OpenAPI 错误码发生变更查看变更详情