All Products
Search

This Product

    Cloud Parallel File Storage:DescribeProtocolService

    Document Center

    Cloud Parallel File Storage:DescribeProtocolService

    Last Updated:Oct 26, 2026

    Queries protocol service information.

    Operation description

    This operation is applicable only to CPFS file systems.

    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:DescribeProtocolService

    list

    *FileSystem

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProtocolServiceIds

    string

    No

    The IDs of the protocol services.

    • Format: CSV

    • Limit: Up to 10 protocol service IDs can be specified.

    ptc-197ed6a00f2b****,ptc-196ed6a00f2b****
    Status

    string

    No

    Filters protocol services by status.

    Format: CSV

    Valid values:

    • Creating: The protocol service is being created.

    • Starting: The protocol service is starting.

    • Running: The protocol service is available.

    • Updating: The protocol service is being updated.

    • Deleting: The protocol service is being deleted.

    • Stopping: The protocol service is stopping.

    • Stopped: The protocol service is stopped.

    Running,Updating
    NextToken

    string

    No

    The pagination token. If the response is truncated, you can use this token to initiate another request to retrieve the remaining results.

    aBcdg==
    MaxResults

    integer

    No

    The maximum number of entries to return for a single request.

    • Maximum value: 100.

    • Minimum value: 10.

    • Default value: 20.

    20
    FileSystemId

    string

    Yes

    The ID of the file system.

    cpfs-099394bd928c****
    Description

    string

    No

    Filters protocol services by description or a part of the description.

    Limits:

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

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

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

    The description of this protocol service
    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 you must 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 of each API request may be different.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The ID of the request.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    NextToken

    string

    The pagination token that is used to query the remaining protocol services.

    aBcdeg==
    ProtocolServices

    array<object>

    The list of protocol services.

    object

    The protocol service information.

    FileSystemId

    string

    The ID of the file system.

    cpfs-099394bd928c****
    ProtocolServiceId

    string

    The ID of the protocol service.

    ptc-197ed6a00f2b****
    ProtocolSpec

    string

    The specifications of the protocol cluster.

    • Valid values: General.

    • Default value: General.

    General
    ProtocolThroughput

    integer

    The throughput of the protocol service. Unit: MB/s.

    500
    InstanceRAM

    integer

    The memory cache size of the protocol node. Unit: GiB.

    0
    InstanceBaseThroughput

    integer

    The base throughput of the protocol node. Unit: MB/s.

    100
    InstanceBurstThroughput

    integer

    The burst throughput of the protocol node. Unit: MB/s.

    100
    MountTargetCount

    integer

    The total number of exported CPFS directories and filesets in the protocol service.

    5
    ProtocolType

    string

    The protocol type supported by the protocol service.

    Valid values:

    • NFS: The protocol service supports access over the NFS protocol.

    NFS
    Status

    string

    The status of the protocol service.

    Valid values:

    • Creating: The protocol service is being created.

    • Starting: The protocol service is starting.

    • Running: The protocol service is available.

    • Updating: The protocol service is being updated.

    • Deleting: The protocol service is being deleted.

    • Stopping: The protocol service is stopping.

    • Stopped: The protocol service is stopped.

    Running
    Description

    string

    The description of the protocol service.

    Limits:

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

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

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

    The description of this protocol service
    CreateTime

    string

    The time when the protocol service was created. The time is displayed in UTC.

    2018-12-12T07:28:38Z
    ModifyTime

    string

    The time when the protocol service was modified. The time is displayed in UTC.

    2018-12-12T07:28:38Z
    VpcId

    string

    The ID of the VPC associated with the protocol service.

    vpc-123xxx
    VSwitchId

    string

    The ID of the vSwitch associated with the protocol service.

    vsw-123xxx

    Examples

    Success response

    JSON format

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NextToken": "aBcdeg==",
  "ProtocolServices": [
    {
      "FileSystemId": "cpfs-099394bd928c****",
      "ProtocolServiceId": "ptc-197ed6a00f2b****",
      "ProtocolSpec": "General",
      "ProtocolThroughput": 500,
      "InstanceRAM": 0,
      "InstanceBaseThroughput": 100,
      "InstanceBurstThroughput": 100,
      "MountTargetCount": 5,
      "ProtocolType": "NFS",
      "Status": "Running",
      "Description": "The description of this protocol service",
      "CreateTime": "2018-12-12T07:28:38Z",
      "ModifyTime": "2018-12-12T07:28:38Z",
      "VpcId": "vpc-123xxx",
      "VSwitchId": "vsw-123xxx"
    }
  ]
}

    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 InvalidParam.TooManyProtocolServiceIds Too many protocol service ids given. The number of protocol service IDs specified in a single query exceeds the limit.
    403 InvalidStatus.NotSupported The specified protocol service status does not support. The status of the specified protocol server cluster is not supported.
    404 InvalidFileSystem.NotFound The specified file system does not exist. The specified file system does not exist.
    404 InvalidParameter.InvalidNextToken The specified NextToken is invaild.
    404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. The specified MaxResults parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.