Queries the configuration information of a share for a gateway.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeGatewayFileShares |
The operation that you want to perform. Set the value to DescribeGatewayFileShares. |
GatewayId | String | Yes | gw-000eg44nmxbsfwbvq*** |
The ID of the gateway. |
IndexId | String | No | NFSd-million |
The ID of the share. If you leave the parameter empty, the configurations of all the shares for the gateway are enumerated. |
Refresh | Boolean | No | true |
Specifies whether to forcibly refresh the cache. Default value: false |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | 200 |
The HTTP status code. If the request is successful, 200 is returned. |
FileShares | Array |
The list of shares. |
|
FileShare | |||
AccessBasedEnumeration | Boolean | false |
Indicates whether authorized enumeration was performed. |
Address | String | 172.16.0.44 |
The IP address of the VPC. |
BeLimit | Integer | 0 |
The maximum upload speed. 0 indicates that the upload speed is not limited. Unit: bytes/s. |
Browsable | Boolean | true |
Indicates whether the share is browsable. |
BucketInfos | String | xxxxx |
The Object Storage Service (OSS) buckets associated with the share. |
BucketsStub | Boolean | false |
Indicates whether multiple OSS buckets are associated with the share. |
CacheMode | String | Cache |
The data synchronization mode of the share. Valid values:
|
ClientSideCmk | String | xxxxx |
The encryption key of the gateway. |
ClientSideEncryption | Boolean | false |
Indicates whether the gateway is encrypted. |
DirectIO | Boolean | false |
Indicates whether direct I/O is enabled. |
DiskId | String | d-bp1cvy8o2569jij31*** |
The ID of the cache disk. Note The parameter is returned only when the gateway is deployed in Alibaba Cloud.
|
DiskType | String | cloud_efficiency |
The type of the cache disk. Valid values:
Note The parameter is returned only when the gateway is deployed in Alibaba Cloud.
|
DownloadLimit | Integer | 0 |
The maximum download speed. 0 indicates that the download speed is not limited. Unit: bytes/s. |
Enabled | Boolean | true |
Indicates whether the share is enabled. |
ExpressSyncId | String | sync-0001xv7je357xn8tr*** |
The ID of the synchronization group. |
FastReclaim | Boolean | false |
Indicates whether the upload optimization feature is enabled. |
FeLimit | Integer | 0 |
The maximum write speed. 0 indicates that the write speed is not limited. Unit: bytes/s. |
FileNumLimit | Long | 10200202 |
The maximum number of files supported by the file system. |
FsSizeLimit | Long | 70368744177664 |
The capacity of the file system. Unit: bytes. |
IgnoreDelete | Boolean | false |
Indicates whether the ignore deletions feature is enabled. |
InPlace | Boolean | false |
Indicates whether the fragment optimization feature is enabled. |
InRate | Long | 0 |
The speed of accelerated caching. Unit: bytes/s. |
IndexId | String | NFSale*** |
The ID of the share. |
KmsRotatePeriod | String | 0 |
The key rotation cycle. |
LagPeriod | Long | 5 |
The upload latency. Unit: seconds. |
LocalPath | String | /dev/vdb |
The path of the cache disk. |
MnsHealth | String | MNSNotEnabled |
The status of a share in the synchronization group. Valid values:
|
Name | String | alex*** |
The name of the share. |
NfsV4Optimization | Boolean | false |
Indicates whether fragment optimization based on the Network File System version 4 (NFSv4) protocol is enabled. |
ObsoleteBuckets | String | bucket1 |
The name of the OSS bucket that is disassociated from the share. |
OssBucketName | String | bucketA |
The name of the OSS bucket. |
OssBucketSsl | Boolean | false |
Indicates whether Secure Sockets Layer (SSL) was used to connect to the OSS bucket. |
OssEndpoint | String | oss-cn-hangzhou-internal.aliyuncs.com |
The endpoint of the OSS bucket. |
OssHealth | String | BucketHealthy |
The status of the OSS bucket. Valid values:
|
OssUsed | Long | 0 |
The amount of data stored in the cloud. Unit: bytes. |
OutRate | Long | 0 |
The upload speed. Unit: bytes/s. |
PartialSyncPaths | String | xxxxx |
The directory of some data synchronized in replication mode. The value is in the JSON format. |
PathPrefix | String | testprefix |
The directory prefix of the OSS bucket. |
PollingInterval | Integer | 0 |
The interval between two consecutive reverse synchronization tasks. |
Protocol | String | SMB |
The type of the share. Valid values:
|
RemainingMetaSpace | Long | 21308227584 |
The capacity of the metadata area. Unit: bytes. |
RemoteSync | Boolean | false |
Indicates whether the reverse synchronization feature is enabled. |
RemoteSyncDownload | Boolean | false |
Indicates whether data was downloaded when data changes of the OSS bucket were synchronized. |
RoClientList | String | user1 |
The IP addresses or CIDR blocks that you allow to only read data from the gateway. The parameter is returned only when the Protocol parameter is set to NFS. |
RoUserList | String | user2 |
The IP addresses or CIDR blocks that you allow to only read data from the gateway. The parameter is returned only when the Protocol parameter is set to SMB. |
RwClientList | String | user3 |
The IP addresses or CIDR blocks that you allow to read data from and write data to the gateway. The parameter is returned only when the Protocol parameter is set to NFS. |
RwUserList | String | user4 |
The IP addresses or CIDR blocks that you allow to read data from and write data to the gateway. The parameter is returned only when the Protocol parameter is set to SMB. |
ServerSideCmk | String | xxxxx |
The encryption key of the OSS bucket. |
ServerSideEncryption | Boolean | false |
Indicates whether the OSS bucket is encrypted. |
Size | Long | 85899345920 |
The capacity of the cache disk. Unit: bytes. |
Squash | String | root_squash |
The user mapping. |
State | String | clean |
The synchronization status of data. Valid values:
|
SupportArchive | Boolean | false |
Indicates whether transparent archiving is supported. |
SyncProgress | Integer | -2 |
The progress of full data synchronization.
|
TotalDownload | Long | 0 |
The amount of data downloaded from the OSS bucket to the gateway. Unit: bytes. |
TotalUpload | Long | 0 |
The amount of data uploaded from the OSS bucket to the gateway. Unit: bytes. |
TransferAcceleration | Boolean | false |
Indicates whether the transfer acceleration feature is enabled. |
Used | Long | 0 |
The consumed capacity of the cache disk. Unit: bytes. |
WindowsAcl | Boolean | false |
Indicates whether an access control list (ACL) is supported. |
Message | String | successful |
The description of the status code. |
RequestId | String | 9A3C3C32-3F37-4658-9D38-945D0799CA0E |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeGatewayFileShares
&GatewayId=gw-000eg44nmxbsfwbvq***
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | GatewayNotExist | The specified gateway does not exist. You must specify a valid parameter. | The error message returned because the specified gateway does not exist. Check whether the parameters are valid. |
400 | GatewayInUpgrading | The gateway is upgrading. Try again later. | The error message returned because the gateway is being upgraded. Try again later. |
400 | EmptyGatewayId | You must enter a valid ID for the gateway. | The error message returned because the gateway ID is not specified. |
For a list of error codes, visit the API Error Center.