获取动态挂载存储信息列表 - ListDynamicStorages

功能介绍

此接口用于获取指定Notebook实例下挂载的动态存储信息列表。

适用场景：用户需要获取指定Notebook实例下挂载的动态存储的存储id、存储类型、挂载路径、挂载状态等信息的场景。若挂载失败，会返回相应错误信息。

接口约束

暂无约束。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

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

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。取值范围：正整数。
data	Array of DataVolumesRes objects	参数解释：动态挂载存储实例数据。
pages	Integer	参数解释：总的页数。取值范围：正整数。
size	Integer	参数解释：每一页的数量。取值范围：正整数。
total	Long	参数解释：总的记录数量。取值范围：非负整数。

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

请求示例

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

响应示例

状态码：200

OK。

{
  "current" : 1,
  "data" : [ {
    "id" : "91dd2d3f-2d92-475f-a375-04636af26cc9",
    "category" : "OBSFS",
    "mount_path" : "/data/mnt/obsfs/",
    "uri" : "obs://bucket-name/dir/to/mount/",
    "status" : "MOUNTED"
  }, {
    "id" : "16d45f01-36c4-43ad-b686-630ae2141665",
    "category" : "EFS",
    "mount_path" : "/data/mnt/efs/",
    "uri" : "efa18c35-72f1-48a3-b2f7-7615da361f1a.sfsturbo.internal:/dir/to/mount/",
    "status" : "MOUNT_FAILED",
    "failure_reason" : "Connection timed out, exit status 32"
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}