DescribeFilesystemsVscAttachInfo - Cloud Parallel File Storage

Queries the information about virtual storage channels associated with file systems.

Operation description

Only CPFS for Lingjun supports this feature. To use CPFS for Lingjun, submit a ticket to apply for the service whitelist before creating a file system in the NAS console.
Batch execution is supported. In batch mode, only one VscId can be associated with multiple FileSystemIds. The ResourceIds.VscId values must be identical.
To query the association results between file systems and virtual storage channels, call AttachVscToFilesystems first. You can call the ListVscs operation of Lingjun eflo-controller/2022-12-15 to query the VscId. If no VscId is available, call CreateVsc to create one.

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

list

*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. You can specify up to 10 items per batch.
	object	No	The IDs of the file systems and virtual storage channels. You can specify up to 10 items per batch.
FileSystemId	string	No	The ID of the file system. This parameter is required in each ResourceIds entry and must be provided together with VscId.	bmcpfs-290t15yn4uo8lid****
VscId	string	No	The ID of the virtual storage channel. This parameter is required in each ResourceIds entry and must be provided together with FileSystemId. The ID starts with vsc-. You can call the ListVscs operation of Lingjun eflo-controller/2022-12-15 to query the VscId. If no VscId is available, call CreateVsc to create one.	vsc-8vb864o3ppwfvh****
NextToken	string	No	The query token. The value is the NextToken value returned from the previous API call.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	No	The maximum number of results to return per query. Valid values: 10 to 100. Default value: 10.	10
RoleChain	array<object>	No	The role chain. Note Required only for cross-account scenarios.
	object	No
RoleType	string	No	The role type. 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. This parameter specifies the Alibaba Cloud account for which the service assumes the role.	101522855006****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
NextToken	string	The query token. The value is the NextToken value returned from the previous API call.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
TotalCount	integer	The total number of association records.	1
MaxResults	integer	The maximum number of entries returned per query. Valid values: 10 to 1000. Default value: 10.	10
VscAttachInfo	object
VscAttachInfo	array<object>	The collection of associate data between file systems and vchannel.
	object
FileSystemId	string	The ID of the file system.	bmcpfs-290t15yn4uo8lid****
VscId	string	The ID of the virtual storage channel.	vsc-8vb864o3ppwfvh****
Status	string	The associate status between the file system and the vchannel. Valid values: Attaching: The associate is in progress. Attached: The associate is complete. Detaching: The dissociate is in progress. Detached: The dissociate is complete. Failed: The associate failed.	Attached

Examples

Success response

JSON format

{
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "TotalCount": 1,
  "MaxResults": 10,
  "VscAttachInfo": {
    "VscAttachInfo": [
      {
        "FileSystemId": "bmcpfs-290t15yn4uo8lid****\n",
        "VscId": "vsc-8vb864o3ppwfvh****\n",
        "Status": "Attached"
      }
    ]
  }
}

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.