ModifyProtocolService - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

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

Operation description

This operation is available only to Cloud Parallel File Storage (CPFS) file systems on the China site (aliyun.com).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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: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.	ptc-123****
FileSystemId	string	Yes	The ID of the file system.	cpfs-123****
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 and cannot start with `http://` or `https://`. The description can contain letters, digits, colons (:), underscores (_), and hyphens (-).	test
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. The dry run checks parameter validity and prerequisites. The dry run does not modify a file system or incur fees. Valid values: true: performs only a dry run and does not modify the protocol service. The system checks the request format, service limits, prerequisites, and whether the required parameters are specified. If the request fails the dry run, an error message is returned. If the request passes the dry run, a 200 HTTP status code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, the service protocol is 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 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.	123e4567-e89b-12d3-a456-42665544****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingFileSystemId	FileSystemId is mandatory for this action.	-
400	MissingProtocolServiceId	ProtocolServiceId is mandatory for this action.	-
403	Instance.IncorrectStatus	The specified instance is in an incorrect status.	-
403	InvalidProtocolSpec.NotSupported	The specified protocol spec does not supported.	-
403	PermissionDenied.ThroughputInvalid	Standard protocol service should not specified throughput.	-
403	InvalidVSwitchId.IpShortage	The specified vswitch ip shortage.	The available IP addresses within the CIDR block of the specified vSwitch are insufficient.
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.	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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-05	The Error code has changed	View Change Details