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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeGatewayFileShares

系统规定参数。取值：DescribeGatewayFileShares。
GatewayId String 是 gw-000eg44nmxbsfwbvq***

网关ID。
IndexId String 否 NFSd-million

文件共享的ID。如果该字段为空，则枚举该网关上的所有文件共享的配置信息。
Refresh Boolean 否 true

是否强制刷新缓存。

默认值：false。

返回数据

名称 类型 示例值 描述
Code String 200

状态码。状态码为200表示请求成功。
FileShares Array

共享配置信息。
FileShare
AccessBasedEnumeration Boolean false

是否基于访问权限的枚举。
Address String 172.16.0.44

共享的VPC内网地址。
BeLimit Integer 0

最大上传速度。0代表无限制。单位：B/s。
Browsable Boolean true

共享是否可浏览。
BucketInfos String xxxxx

多Bucket信息。
BucketsStub Boolean false

是否多Bucket。
CacheMode String Cache

文件共享缓存模式。可能值：

  • Cache：缓存模式。
  • Sync：复制模式。
  • WriteThrough：写透模式。
ClientSideCmk String xxxxx

网关侧加密key。
ClientSideEncryption Boolean false

是否网关侧加密。
DirectIO Boolean false

是否Direct IO。
DiskId String d-bp1cvy8o2569jij31***

文件共享对应缓存盘的ID。

说明 仅线上网关返回该值。
DiskType String cloud_efficiency

缓存盘类型。可能值：

  • cloud_efficiency：高效云盘。
  • cloud_ssd：SSD云盘。
说明 仅线上网关返回该值。
DownloadLimit Integer 0

最大下载速度。0代表无限制。单位：B/s。
Enabled Boolean true

共享是否生效。
ExpressSyncId String sync-0001xv7je357xn8tr***

极速同步组ID。
FastReclaim Boolean false

是否上传优化。
FeLimit Integer 0

最大写入速度。0代表无限制。单位：B/s。
FileNumLimit Long 10200202

文件系统支持的文件数目。
FsSizeLimit Long 70368744177664

文件系统容量。单位：B。
IgnoreDelete Boolean false

是否忽略删除。
InPlace Boolean false

是否碎片优化。
InRate Long 0

缓存增速。单位：B/s。
IndexId String NFSale***

文件共享ID。
KmsRotatePeriod String 0

密钥轮转周期。
LagPeriod Long 5

上传延时。单位：s。
LocalPath String /dev/vdb

缓存盘内部设备名。
MnsHealth String MNSNotEnabled

消息队列健康状态。可能值：

  • TopicAndQueueFailure: 消息队列消息主题无法访问。
  • TopicFailure: 消息主题无法访问。
  • MNSFullSyncInit: 全量同步等待中。
  • MNSFullSyncing: 全量同步进行中 。
  • QueueFailure: 消息队列无法访问。
  • MNSNotEnabled: 极速同步未开启。
  • MNSHealthy: 同步正常。
Name String alex***

共享名称。
NfsV4Optimization Boolean false

是否NFS V4优化。
ObsoleteBuckets String bucket1

多Bucket下，正在移除的Bucket。
OssBucketName String bucketA

Bucket名称。
OssBucketSsl Boolean false

是否使用SSL连接OSS Bucket。
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不存在。
  • 什么都没返回：未知。
OssUsed Long 0

云端数据量。单位：B。
OutRate Long 0

上传速度。单位：B/s。
PartialSyncPaths String xxxxx

部分复制模式下，目录路径组，JSON格式。
PathPrefix String testprefix

OSS Prefix。
PollingInterval Integer 0

反向同步时间间隔。
Protocol String SMB

共享类型。可能值：

  • SMB。
  • NFS。
RemainingMetaSpace Long 21308227584

可使用元数据空间。单位：B。
RemoteSync Boolean false

是否反向同步。
RemoteSyncDownload Boolean false

反向同步下是否下载文件数据。
RoClientList String user1

只读客户端列表。当Protocol为NFS时返回。
RoUserList String user2

只读客户端列表。当Protocol为SMB时返回。
RwClientList String user3

读写客户端列表。当Protocol为NFS时返回。
RwUserList String user4

读写客户端列表。当Protocol为SMB时返回。
ServerSideCmk String xxxxx

文件共享启用服务端加密情况下, 加密所使用的KMS key。
ServerSideEncryption Boolean false

是否OSS Bucket侧加密。
Size Long 85899345920

缓存容量。单位：B。
Squash String root_squash

用户映射。
State String clean

文件同步状态。可能值：

  • clean：同步完成。
  • dirty：同步未完成。
SupportArchive Boolean false

是否支持归档透明读取。
SyncProgress Integer -2

全量同步进度。

  • 当共享已加入同步组的情况下，该返回参数有效， 表明共享全量同步进度(0 ~ 100)。
  • -2：表示共享所在网关版本不支持该功能。
  • -1：表示共享并未发生全量同步。
TotalDownload Long 0

从OSS Bucket到网关总下载量。单位：B。
TotalUpload Long 0

从OSS Bucket到网关总上传量。单位：B。
TransferAcceleration Boolean false

是否开启传输加速。
Used Long 0

已使用缓存。单位：B。
WindowsAcl Boolean false

是否Windows权限支持。
Message String successful

请求结果描述。
RequestId String 9A3C3C32-3F37-4658-9D38-945D0799CA0E

请求ID。
Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeGatewayFileShares
&GatewayId=gw-000eg44nmxbsfwbvq***
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeGatewayFileSharesResponse>
      <RequestId>B869CECE-E58E-4FBD-969F-2FA6F0C399D5</RequestId>
      <Message>successful</Message>
      <FileShares>
            <FileShare>
                  <FileNumLimit>10000000</FileNumLimit>
                  <BucketInfos>[]</BucketInfos>
                  <TotalDownload>0</TotalDownload>
                  <InRate>0</InRate>
                  <Address>172.16.0.44</Address>
                  <TotalUpload>0</TotalUpload>
                  <Size>85899345920</Size>
                  <DownloadLimit>0</DownloadLimit>
                  <LocalPath>/dev/vdb</LocalPath>
                  <OssUsed>0</OssUsed>
                  <ClientSideCmk></ClientSideCmk>
                  <BeLimit>0</BeLimit>
                  <Name>alex***</Name>
                  <DiskType>cloud_efficiency</DiskType>
                  <OutRate>0</OutRate>
                  <MnsHealth>MNSNotEnabled</MnsHealth>
                  <RemoteSyncDownload>false</RemoteSyncDownload>
                  <ClientSideEncryption>false</ClientSideEncryption>
                  <SupportArchive>false</SupportArchive>
                  <Browsable>false</Browsable>
                  <BucketsStub>false</BucketsStub>
                  <FastReclaim>false</FastReclaim>
                  <RemainingMetaSpace>21308227584</RemainingMetaSpace>
                  <FeLimit>0</FeLimit>
                  <KmsRotatePeriod>0</KmsRotatePeriod>
                  <State>clean</State>
                  <InPlace>false</InPlace>
                  <OssBucketName>alexpic1</OssBucketName>
                  <PollingInterval>0</PollingInterval>
                  <DiskId>d-bp1cvy8o2569jij31***</DiskId>
                  <RemoteSync>false</RemoteSync>
                  <AccessBasedEnumeration>false</AccessBasedEnumeration>
                  <WindowsAcl>false</WindowsAcl>
                  <FsSizeLimit>70368744177664</FsSizeLimit>
                  <CacheMode>Cache</CacheMode>
                  <TransferAcceleration>false</TransferAcceleration>
                  <Squash>root_squash</Squash>
                  <NfsFullPath>/mnt/3fc3e189-3842-4c8d-9aa9-104cc3e657fd/share/nfsexpo***</NfsFullPath>
                  <OssEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</OssEndpoint>
                  <NfsV4Optimization>false</NfsV4Optimization>
                  <ServerSideEncryption>false</ServerSideEncryption>
                  <Protocol>NFS</Protocol>
                  <PathPrefix></PathPrefix>
                  <LagPeriod>5</LagPeriod>
                  <OssHealth>BucketHealthy</OssHealth>
                  <IndexId>NFSalex***</IndexId>
                  <Enabled>true</Enabled>
                  <DirectIO>false</DirectIO>
                  <OssBucketSsl>true</OssBucketSsl>
                  <SyncProgress>-2</SyncProgress>
                  <IgnoreDelete>false</IgnoreDelete>
                  <Used>0</Used>
            </FileShare>
      </FileShares>
      <Code>200</Code>
      <Success>true</Success>
</DescribeGatewayFileSharesResponse>

JSON 格式 

{
    "RequestId":"B869CECE-E58E-4FBD-969F-2FA6F0C399D5",
    "Message":"successful",
    "FileShares":{
        "FileShare":[
            {
                "FileNumLimit":10000000,
                "BucketInfos":"[]",
                "TotalDownload":0,
                "InRate":0,
                "Address":"172.16.0.44",
                "TotalUpload":0,
                "Size":85899345920,
                "DownloadLimit":0,
                "LocalPath":"/dev/vdb",
                "OssUsed":0,
                "ClientSideCmk":"",
                "BeLimit":0,
                "Name":"alex***",
                "DiskType":"cloud_efficiency",
                "OutRate":0,
                "MnsHealth":"MNSNotEnabled",
                "RemoteSyncDownload":false,
                "ClientSideEncryption":false,
                "SupportArchive":false,
                "Browsable":false,
                "BucketsStub":false,
                "FastReclaim":false,
                "RemainingMetaSpace":21308227584,
                "FeLimit":0,
                "KmsRotatePeriod":0,
                "State":"clean",
                "InPlace":false,
                "OssBucketName":"alexpic1",
                "PollingInterval":0,
                "DiskId":"d-bp1cvy8o2569jij31***",
                "RemoteSync":false,
                "AccessBasedEnumeration":false,
                "WindowsAcl":false,
                "FsSizeLimit":70368744177664,
                "CacheMode":"Cache",
                "TransferAcceleration":false,
                "Squash":"root_squash",
                "NfsFullPath":"/mnt/3fc3e189-3842-4c8d-9aa9-104cc3e657fd/share/nfsexpo***",
                "OssEndpoint":"oss-cn-hangzhou-internal.aliyuncs.com",
                "NfsV4Optimization":false,
                "ServerSideEncryption":false,
                "Protocol":"NFS",
                "PathPrefix":"",
                "LagPeriod":5,
                "OssHealth":"BucketHealthy",
                "IndexId":"NFSalex***",
                "Enabled":true,
                "DirectIO":false,
                "OssBucketSsl":true,
                "SyncProgress":-2,
                "IgnoreDelete":false,
                "Used":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不能为空。

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