Delete a protocol service with DeleteProtocolService - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Operation description

This operation applies only to Cloud Parallel File Storage (CPFS) file systems.
When you delete a protocol service, the export directories in the protocol service are also deleted.

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

delete

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProtocolServiceId	string	Yes	The ID of the protocol service.	ptc-197ed6a00f2b****
FileSystemId	string	Yes	The ID of the file system.	cpfs-099394bd928c****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, and you must make sure that the value is unique among different requests. The client 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 client token. The RequestId of each API request may be different.	123e4567-e89b-12d3-a456-42665544****
DryRun	boolean	No	Specifies whether to perform a dry run on the request. A dry run helps you check parameter validity and dependencies. It does not actually modify the instance or incur fees. Valid values: true: sends a check request and does not modify the protocol service. The check items include whether required parameters are specified, the request format, and business limits and dependencies. If the check fails, the corresponding error is returned. If the check passes, the HTTP status code 200 is returned. false: sends a normal request and directly modifies the protocol service after the check passes. This is the default value.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	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	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.
404	InvalidProtocolService.NotFound	The specified protocol service does not exist.	The specified protocol service does not exist.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.