All Products
Search

This Product

    Cloud Parallel File Storage:ModifyProtocolService

    Document Center

    Cloud Parallel File Storage:ModifyProtocolService

    Last Updated:Sep 03, 2026

    Modifies a protocol service. You can modify the description of a protocol service.

    Operation description

    This operation applies only to Cloud Parallel File Storage (CPFS) file systems.

    • This operation allows you to modify the description of a protocol service.

    • You can obtain the protocol service ID (ProtocolServiceId) by using one of the following methods:

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    nas:ModifyProtocolService

    update

    *FileSystem

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProtocolServiceId

    string

    Yes

    The ID of the protocol service. You can obtain the protocol service ID from the response of the CreateProtocolService operation, or query it by calling the DescribeProtocolService operation.

    ptc-197ed6a00f2b****
    FileSystemId

    string

    Yes

    The ID of the file system.

    cpfs-099394bd928c****
    Description

    string

    No

    The description of the protocol service.

    Limits:

    • The description must be 2 to 128 characters in length.

    • The description must start with a letter or a Chinese character and cannot start with http:// or https://.

    • The description can contain digits, colons (:), underscores (_), or hyphens (-).

    • Spaces and other special characters are not allowed. Valid example: My-Protocol-Service_01.

    My-Protocol-Service_01
    DryRun

    boolean

    No

    Specifies whether to perform a dry run for this modification request. A dry run checks parameter validity and dependencies without actually modifying the instance or incurring charges.

    Valid values:

    • true: Sends a dry run request without modifying the protocol service. The dry run checks whether required parameters are specified, whether the request format is valid, and whether business constraints and dependencies are met. If the check fails, the corresponding error is returned. If the check succeeds, HTTP status code 200 is returned.

    • false (default): Sends a normal request. After the check succeeds, the protocol service is directly modified.

    false
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests.

    The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

    Note

    If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingFileSystemId FileSystemId is mandatory for this action. The FileSystemId parameter is not specified.
    400 MissingProtocolServiceId ProtocolServiceId is mandatory for this action. The ProtocolServiceId parameter is not specified.
    403 Instance.IncorrectStatus The specified instance is in an incorrect status. The operation is not allowed in the current state.
    403 InvalidProtocolSpec.NotSupported The specified protocol spec does not supported. The specified ProtocolSpec is not supported.
    403 PermissionDenied.ThroughputInvalid Standard protocol service should not specified throughput. The general-purpose protocol service does not allow you to specify the service bandwidth.
    403 InvalidVSwitchId.IpShortage The specified vswitch ip shortage.
    403 OperationDenied.InvalidPtcStatus The operation is denied due to invalid protocol service status. The current protocol service status does not support this operation.
    403 OperationDenied.InvalidState The operation is denied due to invalid file system state.
    403 OperationDenied.NotSupported The operation is denied due to not supported. The file system does not support the protocol service.
    403 PermissionDenied.CLThroughputInvalid Throughput of caching protocol service is invalid. The bandwidth of the cache-type protocol service is invalid.
    404 InvalidFileSystem.NotFound The specified file system does not exist. The specified file system does not exist.
    404 InvalidProtocolService.NotFound The specified protocol service does not exist. The specified protocol service does not exist.
    404 InvalidDescription.InvalidFormat Description format is invalid. The specified description format is invalid.
    404 OperationDenied.NoStock The operation is denied due to no stock. The file system is out of stock.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.