DescribeGatewayFileStatus - 查询文件共享下文件的状态

查询文件网关某个共享下单个文件的状态。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewayFileStatus

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

GatewayId

string

网关 ID。

gw-0004wacp5e4ll1542****

IndexId

string

文件共享 ID。可以通过 DescribeGatewayFileShares 接口获得。

NFSalex-gx-nfs-1201****

FilePath

string

文件路径。

sub/cptestfile****

返回参数

名称

类型

描述

示例值

object

Status

string

查询文件网关某个共享下某个文件的状态,返回值如下:

  • Not found:文件路径不存在。

  • Clean:文件已同步。

  • Waiting to upload:文件待上传。

  • Uploading:文件上传中。

  • Waiting to download:文件待下载。

  • Downloading:文件下载中。

  • Unknown status:文件状态未知, 建议重试。

Clean

Message

string

请求结果描述。

successful

RequestId

string

请求 ID。

1EDBC004-6B1C-4511-ACF5-0B4875BA****

Code

string

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

200

Success

boolean

请求结果。返回值如下:

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 BadRequest Invalid request. You must specify valid parameters in the request.  非法请求,请检查请求参数。

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

变更历史

更多信息,参考变更详情