获取动态挂载OBS实例详情 - ShowAttachableObs

功能介绍

获取动态挂载OBS实例详情接口用于获取已挂载到运行中Notebook实例中的OBS并行文件系统实例的详细信息。该接口适用于以下场景：用户需要查看Notebook实例中已挂载的OBS实例的详细信息时，可通过此接口获取挂载的OBS实例信息。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例和OBS实例的权限，同时Notebook实例必须处于运行状态。调用该接口后，系统将返回指定Notebook实例中挂载的OBS实例的详细信息。若用户无权限访问指定实例或Notebook实例未运行，接口将返回相应的错误信息。

接口约束

暂无约束。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:notebook:getMountedStorage
Read
notebook *
-
-
-
-
g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:notebook:getMountedStorage	Read	notebook *	-	-	-
-	g:EnterpriseProjectId

URI

GET /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

表1 路径参数
参数	是否必选	参数类型	描述
instance_id	是	String	参数解释：Notebook实例ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID），可通过调用查询Notebook实例列表接口获取。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
project_id	是	String	参数解释：用户项目ID，获取方法请参见获取项目ID和名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
storage_id	是	String	参数解释：OBS存储ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
category	String	参数解释：存储类型。可选值为OBSFS。取值范围：不涉及。
id	String	参数解释：动态挂载实例ID。取值范围：不涉及。
mount_path	String	参数解释：在Notebook实例中挂载的路径。取值范围：不涉及。
status	String	参数解释：动态挂载OBS状态。取值范围：枚举类型，取值如下： MOUNTING：挂载中 MOUNT_FAILED：挂载失败 MOUNTED：已挂载 UNMOUNTING：卸载中 UNMOUNT_FAILED：卸载失败 UNMOUNTED：卸载完成
uri	String	参数解释：OBS对象路径。取值范围：不涉及。
failure_reason	String	参数解释：挂载失败原因。取值范围：不涉及。
efs_id	String	参数解释：EFS存储实例ID。取值范围：不涉及。
mount_type	String	参数解释：存储挂载类型。取值范围：枚举类型，取值如下： STATIC:不支持在实例运行期间挂载以及卸载的存储 DYNAMIC:支持在实例运行期间挂载以及卸载的存储

请求示例

GET https://{endpoint}/v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

响应示例

状态码：200

OK。

{
  "id" : "91dd2d3f-2d92-475f-a375-04636af26cc9",
  "category" : "OBSFS",
  "mount_path" : "/data/wang/",
  "uri" : "obs://authoring-test/wang/",
  "status" : "MOUNTED"
}