ModifyProtocolMountTarget to change the description of an export directory - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Modifies the export directory parameters of a protocol service. You can modify only the permission group and description. The VPC ID and vSwitch ID cannot be modified. To change them, delete the export directory and create a new one.

Operation description

Before you begin: This operation applies only to Cloud Parallel File Storage (CPFS) file systems.
Status prerequisite: Before calling this operation, the export directory corresponding to ExportId must be in the AVAILABLE state. Call DescribeProtocolMountTarget to query the status and wait until the creation is complete before retrying.
Dependency chain:
1. Call DescribeFileSystems (with FileSystemType set to cpfs) to obtain the CPFS file system.
2. Call DescribeProtocolService to verify that the protocol service is in the Running state.
3. Call DescribeProtocolMountTarget to verify that the export directory is in the AVAILABLE state.
4. If no export directory exists, call CreateProtocolMountTarget to create one first.

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

update

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProtocolServiceId	string	Yes	The protocol service ID. Call DescribeProtocolService to obtain the protocol service information.	ptc-197ed6a00f2b****
ExportId	string	Yes	The export directory ID of the protocol service. Call DescribeProtocolMountTarget to obtain the export directory information.	exp-19abf5beab8d****
FileSystemId	string	Yes	The file system ID. Call DescribeFileSystems (with FileSystemType set to cpfs) to obtain the file system information.	cpfs-099394bd928c****
Description	string	No	The description of the export directory of the protocol service. Limits: The description must be 2 to 128 characters in length. The description must start with a letter or Chinese character and cannot start with `http://` or `https://`. The description can contain digits, colons (:), underscores (_), and hyphens (-).	Description of this export directory
DryRun	boolean	No	Specifies whether to perform a dry run for this modification request. A dry run checks parameter validity and dependency conditions without actually modifying the export directory or incurring charges. Valid values: true: Sends a dry run request without modifying the export directory. The check items include required parameters, request format, and business dependency conditions. DryRun=true also performs resource status checks (including the requirement that the export directory is in the AVAILABLE state). If the export directory status does not meet the requirements (such as CREATING), the corresponding error is returned. DryRun does not bypass status checks. It only validates request parameter validity and basic dependencies. If the check fails, the corresponding error is returned. If the check passes, HTTP status code 200 is returned. false (default): Sends a normal request. After the check passes, the export directory parameters are directly modified.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique value from your client to ensure that different requests have unique ClientToken values. ClientToken supports 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 uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

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	MissingExportId	ExportId is mandatory for this action.	The ExportId parameter is not specified.
400	MissingAccessGroupName	AccessGroupName is mandatory for this action.	No permission group is 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.InvalidMntStatus	The operation is denied due to invalid protocol mount targte status.
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	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	InvalidExportId.NotFound	The specified ExportId does not exist.	The specified protocol service export directory does not exist.
404	InvalidAccessGroupName.NotFound	The specified access group does not exist.	The specified permission group does not exist.
404	InvalidAccessGroupName.NotAccessRule	There has no rule in access group.	The specified permission group contains no rules.
404	InvalidDescription.InvalidFormat	Description format is invalid.	The specified description format is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.