Querying Details of a Notebook Instance
Function
This API is used to obtain the details of a specified notebook instance.
This API applies to the following scenario: When you need to view the detailed configuration and status of a specified notebook instance or obtain the access link, you can use this API to obtain related information. Before using this API, ensure that a notebook instance exists and you have the query permission. After the API is successfully called, the system returns the instance ID, name, specifications, image, status, and URL for access the instance. If the instance does not exist or you do not have the access permission, 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/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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
Parameter |
Type |
Description |
---|---|---|
action_progress |
Array of JobProgress objects |
Definition: Initialization progress of the instance. |
description |
String |
Definition: Instance description. Range: N/A |
endpoints |
Array of EndpointsRes objects |
Definition: Local IDE (such as PyCharm and VS Code) or SSH client for remotely accessing a notebook instance through SSH. |
fail_reason |
String |
Definition: Instance failure cause. Range: N/A |
flavor |
String |
Definition: Instance flavor. Range: N/A |
id |
String |
Definition: Instance ID. Range: N/A |
image |
Image object |
Definition: Instance image information. |
lease |
Lease object |
Definition: Countdown to auto stop of an instance. |
name |
String |
Definition: Instance name. Range: N/A |
pool |
Pool object |
Definition: Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool. |
status |
String |
Definition: Instance status. Range: |
token |
String |
Description: Token used for notebook authentication. Range: N/A |
url |
String |
Definition: URL for accessing the instance. Range: N/A |
volume |
VolumeRes object |
Definition: Instance storage information. |
workspace_id |
String |
Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A |
feature |
String |
Definition: Instance type. Range: |
billing_items |
Array of strings |
Definition: Billing resource type. Range: |
user |
user object |
Description: Account information. |
Parameter |
Type |
Description |
---|---|---|
notebook_id |
String |
Definition: Instance ID. Range: N/A |
status |
String |
Definition: Job status in a specified step. Range: |
step |
Integer |
Definition: Job step. Range: |
step_description |
String |
Definition: Job description in a specified step. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
allowed_access_ips |
Array of strings |
Definition: Whitelisted public IP addresses that are allowed to access notebook instances through SSH. By default, all public IP addresses can access the notebook instances. If IP addresses are specified, only the clients with the specified IP addresses can access the notebook instances. |
dev_service |
String |
Definition: Method for accessing the notebook instance. Range: |
ssh_keys |
Array of strings |
Definition: List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time. |
service |
String |
Definition: Method for accessing the notebook instance. Range: |
uri |
String |
Definition: Private IP address of the instance. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
arch |
String |
Definition: Processor architecture supported by the image. Range: |
create_at |
Long |
Definition: UTC time when the image is created, accurate to millisecond. Range: N/A |
description |
String |
Definition: Image description. Range: Up to 512 characters |
dev_services |
Array of strings |
Definition: Services supported by the image. Range: |
id |
String |
Definition: ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format. For details, see Querying Supported Images. Range: N/A |
name |
String |
Definition: Image name. Range: The name can contain a maximum of 512 characters. Lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. |
namespace |
String |
Definition: Organization to which the image belongs. You can create and view an organization on the Organization Management page of the SWR console. Range: N/A |
origin |
String |
Definition: Image source. Range: |
resource_categories |
Array of strings |
Definition: Flavors supported by the image. Range: |
service_type |
String |
Definition: Supported image types. Range: |
size |
Long |
Definition: Image size, in KB. Range: N/A |
status |
String |
Definition: Image status. Range: |
status_message |
String |
Definition: Build information during image saving. Range: N/A |
support_res_categories |
Array of strings |
Definition: Flavors supported by the image. Range: |
swr_path |
String |
Definition: SWR image path. Range: N/A |
tag |
String |
Definition: Image tag. Range: N/A |
type |
String |
Definition: Image type. Range: |
update_at |
Long |
Definition: Time (UTC) when the image was last updated, accurate to millisecond. Range: N/A |
visibility |
String |
Definition: Image visibility. Range: |
workspace_id |
String |
Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A |
flavor_type |
String |
Definition: Resource type of the image. Range: |
Parameter |
Type |
Description |
---|---|---|
create_at |
Long |
Definition: UTC time when the instance is created, accurate to millisecond. Range: N/A |
duration |
Long |
Definition: Instance runtime, which is calculated based on the instance creation time. If the instance creation time plus the runtime is greater than the current time, the system automatically stops the instance. Range: N/A |
enable |
Boolean |
Definition: Specifies whether to enable auto stop. Range: Boolean |
type |
String |
Definition: Auto stop type. Range: |
update_at |
Long |
Definition: Time (UTC) when the instance is last updated (excluding liveness check), accurate to millisecond. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Dedicated resource pool ID. Range: N/A |
name |
String |
Definition: Dedicated resource pool name. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
capacity |
Integer |
Definition: Storage capacity. Range: The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB. |
category |
String |
Definition: Supported storage type. For details about the differences between the storage types, see Selecting Storage in DevEnviron. Range: |
mount_path |
String |
Definition: Directory of the notebook instance to which the storage is mounted. Currently, the directory is /home/ma-user/work/. Range: N/A |
ownership |
String |
Definition: Resource owner. Range: |
status |
String |
Definition: EVS disk capacity expansion status, which is RESIZING during capacity expansion and does not affect the instance. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
domain |
domain object |
Description: Domain information of the account. |
id |
String |
Definition: IAM user ID. For details, see Obtaining a Username and ID. Range: N/A |
name |
String |
Definition: IAM username. Range: N/A |
Example Requests
GET https://{endpoint}/v1/{project_id}/notebooks/{id}
Example Responses
Status code: 200
OK
{ "description" : "api-test", "feature" : "NOTEBOOK", "flavor" : "modelarts.vm.cpu.2u", "id" : "f9937afa-631e-4a8f-a8f7-3b6c800585f0", "image" : { "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090", "name" : "notebook2.0-mul-kernel-cpu-cp36", "swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.1.B007_V2", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638778344300, "duration" : 3600000, "enable" : true, "update_at" : 1638778344300 }, "name" : "notebooks_test", "status" : "CREATING", "token" : "7b22482a-a4cb-4b46-e3b3-6a793a47967e", "url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-631e-4a8f-a8f7-3b6c800585f0/lab", "workspace_id" : "0" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot