DescribeGatewayFileStatus API Reference for File Gateway - Cloud Storage 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 support 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:DescribeGatewayFileStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-0004wacp5e4ll1542****
IndexId	string	Yes	The ID of the file share. You can call the DescribeGatewayFileShares operation to obtain the ID.	NFSalex-gx-nfs-1201****
FilePath	string	Yes	The path of the file.	sub/cptestfile****

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the file in the file share of the file gateway. The following values are returned: Not found: The file path does not exist. Clean: The file is synchronized. Waiting to upload: The file is waiting to be uploaded. Uploading: The file is being uploaded. Waiting to download: The file is waiting to be downloaded. Downloading: The file is being downloaded. Unknown status: The file status is unknown. We recommend that you retry the request.	Clean
Message	string	The description of the request result.	successful
RequestId	string	The ID of the request.	1EDBC004-6B1C-4511-ACF5-0B4875BA****
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Success	boolean	The result of the request. The following values are returned: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Status": "Clean",
  "Message": "successful",
  "RequestId": "1EDBC004-6B1C-4511-ACF5-0B4875BA****",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	BadRequest	Invalid request. You must specify valid parameters in the request.	Invalid request. You must specify valid parameters in the request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.