Help Center/ ModelArts/ API Reference/ Development Environment Management/ Obtaining the Notebook Instances with OBS Storage Mounted
Updated on 2025-08-20 GMT+08:00

Obtaining the Notebook Instances with OBS Storage Mounted

Function

This API is used to obtain the OBS parallel file system that can be mounted to a running notebook instance.

This API applies to the following scenario: When you need to mount an OBS parallel file system to the specified file directory of a notebook instance, you can use this API to obtain the list of available OBS parallel file systems. Before using this API, ensure that you have logged in to the system and have the permission to access the target notebook instance and OBS parallel file system. In addition, the notebook instance must be running. After this API is called, the system returns the list of OBS parallel file systems that can be dynamically mounted. If you do not have the permission to access the specified notebook instance or the notebook instance is not running, the API will return an error message.

Constraints

No constraints

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Definition: Notebook instance ID. The ID is in the format of a Universally Unique Identifier (UUID). For details about how to obtain the ID, see Querying Notebook Instances.

Constraints: N/A

Range: N/A

Default Value: N/A

project_id

Yes

String

Definition: Project ID. For details, see Obtaining a Project ID and Name.

Constraints: N/A

Range: N/A

Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

current

Integer

Definition: Current page number.

Range: Positive integers

data

Array of DataVolumesRes objects

Definition: Dynamically mounted OBS instances.

pages

Integer

Definition: Total number of pages.

Range: Positive integers

size

Integer

Definition: Number of records on each page

Range: Positive integers

total

Long

Definition: Total number of records.

Range: Non-negative integers

Table 3 DataVolumesRes

Parameter

Type

Description

category

String

Definition: Storage type. The value can be OBS.

Range: N/A

id

String

Definition: ID of the dynamically mounted instance.

Range: N/A

mount_path

String

Definition: Path mounted to the notebook instance.

Range: N/A

status

String

Definition: Status of dynamically mounted OBS storage.

Range:

  • MOUNTING: being mounted

  • MOUNT_FAILED: mounting failed

  • MOUNTED: mounted

  • UNMOUNTING: being unmounted

  • UNMOUNT_FAILED: unmounting failed

  • UNMOUNTED: unmounted

uri

String

Definition: OBS object path.

Range: N/A

Example Requests

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

Example Responses

Status code: 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
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not found

Error Codes

See Error Codes.