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

Obtaining the Notebook Instances with OBS Storage Mounted

Function

This API is used to obtain the notebook instances with OBS storage mounted.

Constraints

None

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

Notebook instance ID.

project_id

Yes

String

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

current

Integer

Current page

data

Array of DataVolumesRes objects

Data

pages

Integer

Total pages

size

Integer

Number of records on each page

total

Long

Total records

Table 3 DataVolumesRes

Parameter

Type

Description

category

String

Storage type The value can be OBS.

id

String

ID of the instance with OBS storage mounted.

mount_path

String

Path where OBS storage is mounted to a notebook instance.

status

String

Status of OBS storage to be mounted. Options:

  • MOUNTING: being mounted

  • MOUNT_FAILED: mounting failed

  • MOUNTED: mounted

  • UNMOUNTING: being unmounted

  • UNMOUNT_FAILED: unmounting failed

  • UNMOUNTED: unmounted

uri

String

OBS object path

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.