AttachVscToFilesystems - File Storage NAS - Alibaba Cloud Documentation Center

Associates a VSC device with a file system.

Operation description

Only CPFS for Lingjun supports this feature.
Batch execution is supported. In batch execution, only one VscId can be associated with multiple FileSystemIds. That is, the ResourceIds.VscId values must be the same.

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

update

*FileSystem

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

*Vsc

acs:eflo:{#regionId}:{#accountId}:vsc/{#VscId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ResourceIds	array<object>	Yes	The IDs of the file systems and virtual storage channels. A maximum of 10 IDs can be specified in each batch. This parameter must be passed in the flat format, such as ResourceIds.1.FileSystemId=bmcpfs-xxx&ResourceIds.1.VscId=vsc-xxx. JSON arrays are not supported.
	object	No	The IDs of the file systems and virtual storage channels. A maximum of 10 IDs can be specified in each batch.
FileSystemId	string	No	The ID of the file system.	bmcpfs-290t15yn4uo8lid****
VscId	string	No	The ID of the virtual storage channel. You can call the ListVscs operation of Lingjun AI Computing Service eflo-controller/2022-12-15 to query the ID. If the virtual storage channel is not created, you can call the CreateVsc operation to create one.	vsc-8vb864o3ppwfvh****
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, but 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 ClientToken. The RequestId of each API request may be different.	123e4567-e89b-12d3-a456-42665544****
RoleChain	array<object>	No	The role chain. Note This parameter is required only in cross-account scenarios.
	object	No
RoleType	string	No	The type of the role. Valid values: service and user.	service
RoleArn	string	No	The resource descriptor of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::123472233814**:role/aliyunnasclientvsc**
AssumeRoleFor	string	No	The UID of the Alibaba Cloud account (the primary account UID). This parameter specifies the Alibaba Cloud account for which the service assumes the role.	176498472570****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	BC7C825C-5F65-4B56-BEF6-98C56C7C****

Examples

Success response

JSON format

{
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter is invalid.	Illegal parameter.
400	InvalidParameter.ResourceIds	Invalid ResourceIds, can not be empty or batch size large than 10.	ResourceIds parameter error: cannot be empty and the batch size cannot exceed 10.
400	InvalidParameter.FileSystem	Invalid FileSystem in ResourceIds.	The file system in the ResourceIds is invalid.
400	InvalidFilesystemType.NotSupport	This Api does not support this fileSystem type.	The current interface does not support this type of file system.
400	InvalidParameter.VscId	Invalid VscId in ResourceIds.	Invalid VscId in ResourceIds.
400	InvalidParameter.VscIds	Invalid VscId in ResourceIds.VscIds must be the same.	Invalid VscId in ResourceIds. VscIds must be the same.
400	Ram.AddRamParamFailed	Ram check has failed due to param invalid, please check param.	Ram check failed because the parameter is invalid, please check the parameter.
400	FeatureOrAPI.NotSupported	The Feature/API is not supported in this region now.	This feature or API is not currently supported in this region.
403	Forbbiden.Ram	User not authorized to operate on the specified resource, or this API doesn't support RAM.	The user is not authorized to operate the specified resource, or the API does not support RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.