获取动态挂载OBS实例信息列表
功能介绍
获取动态挂载OBS实例信息列表接口用于获取可供挂载到运行中Notebook实例中的OBS并行文件系统实例信息。该接口适用于以下场景：用户需要将OBS实例挂载到Notebook实例的指定文件目录时，可通过此接口获取可用的OBS实例列表。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例和OBS实例的权限，同时Notebook实例必须处于运行状态。调用该接口后，系统将返回可供动态挂载的OBS实例信息列表。若用户无权限访问指定实例或Notebook实例未运行，接口将返回相应的错误信息。
接口约束
暂无约束。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/notebooks/{instance_id}/storage
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
参数解释：Notebook实例ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID），可通过调用查询Notebook实例列表接口获取。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
project_id |
是 |
String |
参数解释：用户项目ID，获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
current |
Integer |
参数解释：当前页数。 取值范围：正整数。 |
|
data |
Array of DataVolumesRes objects |
参数解释：动态挂载OBS实例数据。 |
|
pages |
Integer |
参数解释：总的页数。 取值范围：正整数。 |
|
size |
Integer |
参数解释：每一页的数量。 取值范围：正整数。 |
|
total |
Long |
参数解释：总的记录数量。 取值范围：非负整数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
参数解释：存储类型。可选值为OBSFS。 取值范围：不涉及。 |
|
id |
String |
参数解释：动态挂载实例ID。 取值范围：不涉及。 |
|
mount_path |
String |
参数解释：在Notebook实例中挂载的路径。 取值范围：不涉及。 |
|
status |
String |
参数解释：动态挂载OBS状态。 取值范围：枚举类型，取值如下：
|
|
uri |
String |
参数解释：OBS对象路径。 取值范围：不涉及。 |
请求示例
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/wang/",
"uri" : "obs://authoring-test/wang/",
"status" : "MOUNTED"
} ],
"pages" : 1,
"size" : 1,
"total" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
401 |
Unauthorized。 |
|
403 |
Forbidden。 |
|
404 |
Not Found。 |
错误码
请参见错误码。
