DescribeGatewayFileShares - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Describes the configurations of file shares on a file gateway.

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

hcs-sgw:DescribeGatewayFileShares

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbvq***
IndexId	string	No	The ID of the file share. If you leave this parameter empty, the configurations of all file shares on the gateway are returned.	NFSd-million
Refresh	boolean	No	Specifies whether to forcibly refresh the cache. The default value is false.	true

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. A value of 200 indicates that the request is successful.	200
FileShares	object
FileShare	array<object>	The configurations of the shares.
	object
AccessBasedEnumeration	boolean	Indicates whether access-based enumeration is enabled.	false
ActiveMessages	integer	The number of active messages.	0
Address	string	The internal IP address of the share in the VPC.	172.16.0.44
BeLimit	integer	The maximum upload speed. A value of 0 indicates no limit. Unit: B/s.	0
BindIPAddr	string	The mount IP address bound to the share.	192.0.0.0
Browsable	boolean	Indicates whether the share is browsable.	true
BucketInfos	string	The information about multiple buckets.	[{\"Endpoint\":\"oss-cn-hangzhou.aliyuncs.com\",\"Name\":\"bucket1\",\"PathPrefix\":\"\"},{\"Endpoint\":\"oss-cn-hangzhou.aliyuncs.com\",\"Name\":\"bucket2\",\"PathPrefix\":\"\"}]
BucketsStub	boolean	Indicates whether multi-bucket aggregation is enabled. A value of false indicates that the feature is disabled.	false
BypassCacheRead	boolean	Indicates whether the feature of directly reading from OSS is enabled. A value of false indicates that the feature is disabled.	false
CacheMode	string	The cache mode of the file share. Valid values: Cache: cache mode. Sync: replication mode.	Cache
ClientSideCmk	string	Deprecated.	xxx
ClientSideEncryption	boolean	Deprecated.	false
DirectIO	boolean	Deprecated.	false
DiskId	string	The ID of the cache disk that corresponds to the file share. This parameter is returned only for online gateways.	d-bp1cvy8o2569jij31***
DiskType	string	Deprecated.	cloud_efficiency
DownloadLimit	integer	The maximum download speed. A value of 0 indicates no limit. Unit: B/s.	0
DownloadQueue	integer	The download queue.	5
DownloadRate	integer	The download rate. Unit: B/s.	0
Enabled	boolean	Indicates whether the share is enabled.	true
ExpressSyncId	string	The ID of the express synchronization group.	sync-0001xv7je357xn8tr***
FastReclaim	boolean	Indicates whether upload optimization is enabled. A value of false indicates that the feature is disabled.	false
FeLimit	integer	The maximum write speed. A value of 0 indicates no limit. Unit: B/s.	0
FileNumLimit	integer	The number of files that the file system supports.	10200202
FsSizeLimit	integer	The capacity of the file system. Unit: B.	70368744177664
HighWatermark	integer	The high watermark.	80
IgnoreDelete	boolean	Indicates whether the ignore deletions feature is enabled. A value of false indicates that the feature is disabled.	false
InPlace	boolean	Deprecated.	false
InRate	integer	The rate at which data is written to the cache. Unit: B/s.	0
IndexId	string	The ID of the file share.	NFSale***
KmsRotatePeriod	string	The key rotation period. Unit: seconds.	0
LagPeriod	integer	The upload latency. Unit: s.	5
LocalPath	string	The internal device name of the cache disk.	/dev/vdb
LowWatermark	integer	The low watermark.	60
MnsHealth	string	The health status of the message queue. Valid values: TopicAndQueueFailure: The message topic and queue are inaccessible. TopicFailure: The message topic is inaccessible. MNSFullSyncInit: A full synchronization is pending. MNSFullSyncing: A full synchronization is in progress. QueueFailure: The message queue is inaccessible. MNSNotEnabled: Express synchronization is disabled. MNSHealthy: The synchronization is normal.	MNSNotEnabled
Name	string	The name of the share.	alex***
NfsV4Optimization	boolean	Indicates whether NFSv4 optimization is enabled. A value of false indicates that the feature is disabled.	false
NoPartition	boolean	Indicates whether a partition exists. A value of true indicates that no partition exists.	true
ObsoleteBuckets	string	The buckets that are being removed from the multi-bucket aggregation.	bucket1
OssBucketName	string	The name of the bucket.	bucketA
OssBucketSsl	boolean	Indicates whether an SSL connection is used to access the OSS bucket.	false
OssEndpoint	string	The endpoint used to access the OSS bucket.	oss-cn-hangzhou-internal.aliyuncs.com
OssHealth	string	The health status of the OSS bucket. Valid values: BucketHealthy: The OSS connection is normal. BucketAccessDenied: The OSS access permissions are abnormal. BucketMiscFailure: Other OSS access exceptions occurred. BucketNetworkFailure: An OSS network access exception occurred. BucketNotExist: The OSS bucket does not exist. Empty: The status is unknown.	BucketHealthy
OssUsed	integer	The amount of data in the cloud. Unit: B.	0
OutRate	integer	The upload speed. Unit: B/s.	0
PartialSyncPaths	string	The group of directory paths in partial replication mode. This parameter is in the JSON format.	xxx
PathPrefix	string	The OSS subdirectory.	testprefix
PollingInterval	integer	The remote sync interval.	900
Protocol	string	The type of the share. Valid values: SMB NFS	SMB
RemainingMetaSpace	integer	The remaining metadata space. Unit: B.	21308227584
RemoteSync	boolean	Indicates whether remote sync is enabled. A value of false indicates that the feature is disabled.	false
RemoteSyncDownload	boolean	Indicates whether to download file data during a remote sync.	false
RoClientList	string	The list of read-only clients. This parameter is returned when Protocol is set to NFS.	1.1.1.1
RoUserList	string	The list of read-only users. This parameter is returned when Protocol is set to SMB.	user1
RwClientList	string	The list of read-write clients. This parameter is returned when Protocol is set to NFS.	1.1.1.1
RwUserList	string	The list of read-write users. This parameter is returned when Protocol is set to SMB.	user2
ServerSideAlgorithm	string	Deprecated.	AES256
ServerSideCmk	string	Deprecated.	xxx
ServerSideEncryption	boolean	Deprecated.	false
Size	integer	The cache capacity. Unit: B.	85899345920
Squash	string	The user mapping.	root_squash
State	string	The file synchronization status. Valid values: clean: The synchronization is complete. dirty: The synchronization is incomplete.	clean
Status	string	The status of the share. Valid values: started stopped	started
SupportArchive	boolean	Indicates whether transparent reading of archived files is supported.	false
SyncProgress	integer	The progress of the full synchronization. This parameter is valid only when the share is added to a synchronization group. It indicates the progress of the full synchronization, from 0 to 100. -2: indicates that the gateway version does not support this feature. -1: indicates that no full synchronization has occurred.	-2
Throttling	boolean	Indicates whether throttling is enabled for the share. A value of false indicates that throttling is disabled.	false
TotalDownload	integer	The total amount of data downloaded from the OSS bucket to the gateway. Unit: B.	0
TotalUpload	integer	The total amount of data uploaded from the gateway to the OSS bucket. Unit: B.	0
TransferAcceleration	boolean	Indicates whether transfer acceleration is enabled.	false
UploadQueue	integer	The upload queue.	5
Used	integer	The used cache space. Unit: B.	0
WindowsAcl	boolean	Indicates whether support for Windows Access Control Lists (ACLs) is enabled.	false
OssBucketRegionId	string	The region where the Object Storage Service (OSS) bucket of the file share is located.	cn-hangzhou
Message	string	The description of the request result.	successful
RequestId	string	The ID of the request.	9A3C3C32-3F37-4658-9D38-945D0799CA0E
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "FileShares": {
    "FileShare": [
      {
        "AccessBasedEnumeration": false,
        "ActiveMessages": 0,
        "Address": "172.16.0.44",
        "BeLimit": 0,
        "BindIPAddr": "192.0.0.0",
        "Browsable": true,
        "BucketInfos": "[{\\\"Endpoint\\\":\\\"oss-cn-hangzhou.aliyuncs.com\\\",\\\"Name\\\":\\\"bucket1\\\",\\\"PathPrefix\\\":\\\"\\\"},{\\\"Endpoint\\\":\\\"oss-cn-hangzhou.aliyuncs.com\\\",\\\"Name\\\":\\\"bucket2\\\",\\\"PathPrefix\\\":\\\"\\\"}]",
        "BucketsStub": false,
        "BypassCacheRead": false,
        "CacheMode": "Cache",
        "ClientSideCmk": "xxx",
        "ClientSideEncryption": false,
        "DirectIO": false,
        "DiskId": "d-bp1cvy8o2569jij31***",
        "DiskType": "cloud_efficiency",
        "DownloadLimit": 0,
        "DownloadQueue": 5,
        "DownloadRate": 0,
        "Enabled": true,
        "ExpressSyncId": "sync-0001xv7je357xn8tr***",
        "FastReclaim": false,
        "FeLimit": 0,
        "FileNumLimit": 10200202,
        "FsSizeLimit": 70368744177664,
        "HighWatermark": 80,
        "IgnoreDelete": false,
        "InPlace": false,
        "InRate": 0,
        "IndexId": "NFSale***",
        "KmsRotatePeriod": "0",
        "LagPeriod": 5,
        "LocalPath": "/dev/vdb",
        "LowWatermark": 60,
        "MnsHealth": "MNSNotEnabled",
        "Name": "alex***",
        "NfsV4Optimization": false,
        "NoPartition": true,
        "ObsoleteBuckets": "bucket1",
        "OssBucketName": "bucketA",
        "OssBucketSsl": false,
        "OssEndpoint": "oss-cn-hangzhou-internal.aliyuncs.com",
        "OssHealth": "BucketHealthy",
        "OssUsed": 0,
        "OutRate": 0,
        "PartialSyncPaths": "xxx",
        "PathPrefix": "testprefix",
        "PollingInterval": 900,
        "Protocol": "SMB",
        "RemainingMetaSpace": 21308227584,
        "RemoteSync": false,
        "RemoteSyncDownload": false,
        "RoClientList": "1.1.1.1",
        "RoUserList": "user1",
        "RwClientList": "1.1.1.1",
        "RwUserList": "user2",
        "ServerSideAlgorithm": "AES256",
        "ServerSideCmk": "xxx",
        "ServerSideEncryption": false,
        "Size": 85899345920,
        "Squash": "root_squash",
        "State": "clean",
        "Status": "started",
        "SupportArchive": false,
        "SyncProgress": -2,
        "Throttling": false,
        "TotalDownload": 0,
        "TotalUpload": 0,
        "TransferAcceleration": false,
        "UploadQueue": 5,
        "Used": 0,
        "WindowsAcl": false,
        "OssBucketRegionId": "cn-hangzhou"
      }
    ]
  },
  "Message": "successful",
  "RequestId": "9A3C3C32-3F37-4658-9D38-945D0799CA0E",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	The gateway is upgrading. Try again later.
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.