文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ API/ 文件系统管理/ 获取已挂载的客户端ip信息 - ShowClientIpInfo
更新时间:2026-09-30 GMT+08:00
分享

获取已挂载的客户端ip信息 - ShowClientIpInfo

功能介绍

获取已挂载的客户端ip信息。

接口约束

仅获取5分钟内发起访问请求的客户端ip及信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

share_id

是

String

参数解释:

文件系统ID,用于唯一标识SFS Turbo文件系统实例。

获取方法请参见查询文件系统列表接口。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权认证。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

是

String

参数解释:

请求消息体MIME类型,用于标识请求正文的数据格式。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

get_client_ips

是

ClientIpInfo object

参数解释:

获取已挂载客户端IP信息的请求参数对象,传入空对象即可触发查询。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 ClientIpInfo

参数

是否必选

参数类型

描述

ips

否

String

参数解释:

预留字段,用于指定要查询的客户端IP。当前接口实现中未使用该字段进行过滤,直接返回文件系统所有已挂载客户端IP。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表6 响应Body参数

参数

参数类型

描述

id

String

参数解释:

文件系统ID,用于唯一标识SFS Turbo文件系统实例。

取值范围:

不涉及。

ips

Array of strings

参数解释:

已挂载客户端的IP列表。

取值范围:

不涉及。

状态码:400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表8 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

状态码:500

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表10 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

请求示例

查询指定项目下文件系统ID为“a3e7f1c2-9b5d-4e8a-8f6c-2d1b7e4a9c0f”的客户端挂载IP。

POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/a3e7f1c2-9b5d-4e8a-8f6c-2d1b7e4a9c0f/action

{
  "get_client_ips" : {
    "ips" : "192.168.1.100"
  }
}

响应示例

状态码:200

{
  "id" : "a3e7f1c2-9b5d-4e8a-8f6c-2d1b7e4a9c0f",
  "ips" : [ "192.168.1.100", "192.168.1.101" ]
}

状态码:400

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

状态码:500

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

状态码

状态码

描述

200

成功

400

错误响应

500

错误响应

错误码

请参见错误码。

相关文档