Queries the information about protocol services.
Operation description
This operation is available only to Cloud Parallel File Storage (CPFS) file systems.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| nas:DescribeProtocolService | list | *FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProtocolServiceIds | string | No | The ID of the protocol service.
| ptc-197ed6a00f2b****,ptc-196ed6a00f2b**** |
| Status | string | No | The status of the protocol service. Format: CSV. Valid values:
| Running,Updating |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | aBcdg== |
| MaxResults | long | No | The number of results for each query.
| 20 |
| FileSystemId | string | Yes | The ID of the file system. | cpfs-099394bd928c**** |
| Description | string | No | The description or a part of the description of the protocol service. Limits:
| test |
| 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 do I ensure the idempotence? Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "test",
"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. | - |
| 400 | InvalidParam.TooManyProtocolServiceIds | Too many protocol service ids given. | - |
| 403 | InvalidStatus.NotSupported | The specified protocol service status does not support. | - |
| 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. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-12-22 | The Error code has changed. The response structure of the API has changed | View Change Details |