使用DescribeGatewayFileShares API查询文件网关的文件共享配置-云存储网关-阿里云

获取文件网关上共享的配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewayFileShares

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000eg44nmxbsfwbvq***
IndexId	string	否	文件共享的 ID。如果该字段为空，则枚举该网关上的所有文件共享的配置信息。	NFSd-million
Refresh	boolean	否	是否强制刷新缓存。默认值：false。	true

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。状态码为 200 表示请求成功。	200
FileShares	object
FileShare	array<object>	共享配置信息。
	object
AccessBasedEnumeration	boolean	是否基于访问权限的枚举。	false
ActiveMessages	integer	活跃的消息数。	0
Address	string	共享的 VPC 内网地址。	172.16.0.44
BeLimit	integer	最大上传速度。0 代表无限制。单位：B/s。	0
BindIPAddr	string	共享绑定的挂载 IP。	192.0.0.0
Browsable	boolean	共享是否可浏览。	true
BucketInfos	string	多 Bucket 信息。	[{\"Endpoint\":\"oss-cn-hangzhou.aliyuncs.com\",\"Name\":\"bucket1\",\"PathPrefix\":\"\"},{\"Endpoint\":\"oss-cn-hangzhou.aliyuncs.com\",\"Name\":\"bucket2\",\"PathPrefix\":\"\"}]
BucketsStub	boolean	是否已启用多 Bucket 聚合。false 表示未启用。	false
BypassCacheRead	boolean	是否已启用直读 OSS 功能。false 表示未启用。	false
CacheMode	string	文件共享缓存模式。可能值： Cache：缓存模式。 Sync：复制模式。	Cache
ClientSideCmk	string	废弃。	xxx
ClientSideEncryption	boolean	废弃。	false
DirectIO	boolean	废弃。	false
DiskId	string	文件共享对应缓存盘的 ID。仅线上网关返回该值。	d-bp1cvy8o2569jij31***
DiskType	string	废弃。	cloud_efficiency
DownloadLimit	integer	最大下载速度。0 代表无限制。单位：B/s。	0
DownloadQueue	integer	下载队列	5
DownloadRate	integer	下载速率。单位：B/s。	0
Enabled	boolean	共享是否生效。	true
ExpressSyncId	string	极速同步组 ID。	sync-0001xv7je357xn8tr***
FastReclaim	boolean	是否已启用上传优化功能。false 表示未启用。	false
FeLimit	integer	最大写入速度。0 代表无限制。单位：B/s。	0
FileNumLimit	integer	文件系统支持的文件数目。	10200202
FsSizeLimit	integer	文件系统容量。单位：B。	70368744177664
HighWatermark	integer	最高水位设定值。	80
IgnoreDelete	boolean	是否已启用忽略删除功能。false 表示未启用。	false
InPlace	boolean	废弃。	false
InRate	integer	缓存增速。单位：B/s。	0
IndexId	string	文件共享 ID。	NFSale***
KmsRotatePeriod	string	密钥轮转周期。单位为秒。	0
LagPeriod	integer	上传延时。单位：s。	5
LocalPath	string	缓存盘内部设备名。	/dev/vdb
LowWatermark	integer	最低水位设定值。	60
MnsHealth	string	消息队列健康状态。可能值： TopicAndQueueFailure: 消息队列消息主题无法访问。 TopicFailure: 消息主题无法访问。 MNSFullSyncInit: 全量同步等待中。 MNSFullSyncing: 全量同步进行中。 QueueFailure: 消息队列无法访问。 MNSNotEnabled: 极速同步未开启。 MNSHealthy: 同步正常。	MNSNotEnabled
Name	string	共享名称。	alex***
NfsV4Optimization	boolean	是否已启用 NFS V4 优化。false 表示未启用。	false
NoPartition	boolean	是否有分区。true 表示没有。	true
ObsoleteBuckets	string	多 Bucket 聚合下，正在移除的 Bucket。	bucket1
OssBucketName	string	Bucket 名称。	bucketA
OssBucketSsl	boolean	是否使用 SSL 连接 OSS Bucket。	false
OssEndpoint	string	连接 OSS Bucket 的地域节点。	oss-cn-hangzhou-internal.aliyuncs.com
OssHealth	string	OSS Bucket 的健康状态。可能值： BucketHealthy：OSS 连接正常。 BucketAccessDenied : OSS 访问权限异常。 BucketMiscFailure： OSS 访问其他异常。 BucketNetworkFailure： OSS 访问网络异常。 BucketNotExist： OSS Bucket 不存在。什么都没返回：未知。	BucketHealthy
OssUsed	integer	云端数据量。单位：B。	0
OutRate	integer	上传速度。单位：B/s。	0
PartialSyncPaths	string	部分复制模式下，目录路径组，JSON 格式。	xxx
PathPrefix	string	OSS 子目录。	testprefix
PollingInterval	integer	反向同步时间间隔。	900
Protocol	string	共享类型。可能值： SMB。 NFS。	SMB
RemainingMetaSpace	integer	可使用元数据空间。单位：B。	21308227584
RemoteSync	boolean	是否已启用反向同步。false 表示未启用。	false
RemoteSyncDownload	boolean	反向同步下是否下载文件数据。	false
RoClientList	string	只读客户端列表。当 Protocol 为 NFS 时返回。	1.1.1.1
RoUserList	string	只读用户列表。当 Protocol 为 SMB 时返回。	user1
RwClientList	string	读写客户端列表。当 Protocol 为 NFS 时返回。	1.1.1.1
RwUserList	string	读写用户列表。当 Protocol 为 SMB 时返回。	user2
ServerSideAlgorithm	string	废弃。	AES256
ServerSideCmk	string	废弃。	xxx
ServerSideEncryption	boolean	废弃。	false
Size	integer	缓存容量。单位：B。	85899345920
Squash	string	用户映射。	root_squash
State	string	文件同步状态。可能值： clean：同步完成。 dirty：同步未完成。	clean
Status	string	共享的启停状态。可能值： started stopped	started
SupportArchive	boolean	是否支持归档透明读取。	false
SyncProgress	integer	全量同步进度。当共享已加入同步组的情况下，该返回参数有效，表明共享全量同步进度(0 ~ 100)。 -2：表示共享所在网关版本不支持该功能。 -1：表示共享并未发生全量同步。	-2
Throttling	boolean	共享是否限流。false 表示未限流。	false
TotalDownload	integer	从 OSS Bucket 到网关总下载量。单位：B。	0
TotalUpload	integer	从 OSS Bucket 到网关总上传量。单位：B。	0
TransferAcceleration	boolean	是否开启传输加速。	false
UploadQueue	integer	上传队列。	5
Used	integer	已使用缓存。单位：B。	0
WindowsAcl	boolean	是否已启用 Windows 权限支持。	false
OssBucketRegionId	string	文件共享对应的对象存储（OSS）Bucket 所在地域。	cn-hangzhou
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	9A3C3C32-3F37-4658-9D38-945D0799CA0E
Success	boolean	请求结果。返回值如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code	错误码	错误信息	描述
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	网关不存在，请确认输入参数是否正确。
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	网关正在升级中，请稍后再试。
400	EmptyGatewayId	You must enter a valid ID for the gateway.	网关ID不能为空。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。