调用DescribeGatewayFileShares获取网关上共享的配置信息

请求参数

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

返回数据

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeGatewayFileShares
&GatewayId=gw-000eg44nmxbsfwbvq***
&IndexId=NFSd-million
&Refresh=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode	错误码	错误信息	描述
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不能为空。

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