Querying Details About a Development Environment Instance

Function

This API is used to query the details about a development environment instance.

URI

GET /v1/{project_id}/demanager/instances/{instance_id}

Table 1 describes the required parameters.

Table 1 Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID

Request Body

None

Response Body

Table 2 describes the response parameters.

Table 2 Parameters

Parameter	Type	Description
id	String	Instance ID
name	String	Instance name
description	String	Instance description
status	String	Instance status
creation_timestamp	String	Time when an instance is created
profile	Object	Configuration information. For details, see Table 3.
flavor	String	Instance flavor
spec	Object	Instance specifications of the notebook type. For details, see Table 11.
workspace	Object	Workspace. For details, see Table 16.
latest_update_timestamp	String	Time when an instance is modified
flavor_details	Object	Flavor details. See Table 7.
pool	Object	Dedicated resource pool. See Table 8.
ai_project	Object	AI project. For details, see Table 9.
error_code	String	Error code. For details, see Error Codes.
queuing_info	Object	Queuing information. For details, see Table 17.
user	Object	User information. For details, see Table 18.

Table 3 profile parameters

Parameter	Type	Description
id	String	Configuration ID
name	String	Configuration name
description	String	Configuration description
de_type	String	Development environment type. Only Notebook is supported.
provision	Object	Deployment information. For details, see Table 4.
labels	Map<String,String>	Label information
flavor_type	String	Hardware, which can be CPU, GPU.

Table 4 provision parameters

Parameter	Type	Description
type	String	Deployment type. Only Docker is supported.
spec	Object	Deployment details. For details, see Table 5.

Table 5 spec parameters

Parameter	Type	Description
engine	String	Deployment engine. Only CCE is supported.
params	Object	Deployment parameters. Only Docker is supported. For details, see Table 6.

Table 6 Docker deployment parameters

Parameter	Type	Description
namespace	String	SWR organization name, which is globally unique
image_name	String	Image name
image_tag	String	Image tag
annotations	Map<String,String>	Label information, which can be extended. By default, this parameter is left blank.

Table 7 flavor_details parameters

Parameter	Type	Description
name	String	Flavor name
status	String	Flavor sale status The options are as follows: onSale soldOut
queuing_num	Integer	This parameter is mandatory when promo_type is set to Free and status is set to soldOut.
queue_left_time	Integer	Left queuing time, in seconds This parameter is mandatory when promo_type is set to Free and status is set to soldOut.
storage_list	Array<Storage type>	Supported storage type. The options are obs and efs.
is_permitted	Boolean	Whether the current user has the permission to use this flavor
type	String	Flavor status. The options are as follows: GPU CPU
params	Dict	Parameters that describing flavor
promo_type	String	Promotion type. The options are as follows: Free NoDiscount
instance_num	Integer	Number of instances of this flavor the current created
duration	Integer	Auto stop time after startup, in seconds
store_time	Integer	Maximum retention period of an inactive instance of this flavor in the database, in hours The default value is -1, indicating that the instance can be permanently saved.
billing_flavor	String	Billing specifications. If this field is left blank, the specifications name is used for billing.
billing_params	Integer	Billing ratio This parameter is mandatory when billing_flavor is specified.

Table 8 pool parameters

Parameter	Type	Description
id	String	ID of a resource pool
name	String	Name of a resource pool
type	String	Type of a resource pool. USER_DEFINED indicates a dedicated resource pool.
owner	Object	This parameter is mandatory when type is set to USER_DEFINED. For details, see Table 10.

Table 9 AIProject parameters

Parameter	Type	Description
id	String	AI project ID

Table 10 owner parameters

Parameter	Type	Description
project_id	String	Project ID

Table 11 notebook parameters

Parameter	Type	Description
log_path	String	Path for storing custom image logs
custom_script_path	String	Path for storing custom initialization scripts used when a notebook instance is started
storage	Object	Storage path. For details, see Table 12.
credential	Object	AK and SK for accessing OBS. For details, see Table 21.
repository	Object	Git repository information. For details, see Table 19. This parameter cannot be used. It is automatically returned when the API is called.
resource_reserved_timestamp	Integer	Time when the resource is reserved
auto_stop	Object	Auto stop parameter. For details, see Table 14.
failed_reasons	Object	Cause for a creation or startup failure. For details, see Table 15.
annotations	Map<String,String>	Annotations The generated URL cannot be directly accessed.
extend_params	Map<String,String>	Extended parameter

Table 12 storage parameters

Parameter	Type	Description
type	String	Storage type. Only obs is supported.
location	Object	Storage location. If type is set to obs, this parameter is mandatory. See Table 13. By default, this parameter is left blank.

Table 13 location parameters

Parameter	Type	Description
path	String	Storage path If type is set to obs, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket.
volume_size	Integer	If type is set to obs, this parameter does not need to be set.

Table 14 auto_stop parameters

Parameter	Type	Description
enable	Boolean	Whether to enable the auto stop function
duration	Integer	Running duration, in seconds
prompt	Boolean	Whether to display a prompt again. This parameter is provided for the console to use.
stop_timestamp	Integer	Time when the instance stops. The value is a 13-digit timestamp.
remain_time	Integer	Remaining time before actual stop, in seconds

Table 15 failed_reasons parameters

Parameter	Type	Description
code	String	Error code
message	String	Error message
detail	Map<String,String>	Error details

Table 16 workspace parameters

Parameter	Type	Description
id	String	Workspace ID If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

Table 17 queuing_info parameters

Parameter	Type	Description
id	String	Instance ID
name	String	Instance name
de_type	String	Development environment type. By default, all types are returned. Only Notebook is supported.
flavor	String	Instance flavor. By default, all types are returned.
flavor_details	Object	Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 7.
status	String	Instance status. By default, all statuses are returned, including: CREATE_QUEUING START_QUEUING
begin_timestamp	Integer	Time when an instance starts queuing. The value is a 13-digit timestamp.
remain_time	Integer	Left queuing time, in seconds
end_timestamp	Integer	Time when an instance completes queuing. The value is a 13-digit timestamp.
rank	Integer	Ranking of an instance in a queue

Table 18 user parameters

Parameter	Type	Description
id	String	User ID
name	String	Username

Table 19 repository parameters

Parameter	Type	Description
id	String	Repository ID
branch	String	Repository branch
user_name	String	Repository username
user_email	String	Repository user mailbox
type	String	Repository type. The options are CodeClub and GitHub.
connection_info	Object	Repository link information. For details, see Table 20.

Table 20 connection_info parameters

Parameter	Type	Description
protocol	String	Repository link protocol. The options are ssh and https.
url	String	Repository link address
credential	Object	Certificate information. For details, see Table 21.

Table 21 credential parameters

Parameter	Type	Description
ssh_private_key	String	SSH private certificate
access_token	String	OAuth token of GitHub

Samples

The following shows how to obtain the details about instance 6fa459ea-ee8a-3ca4-894e-db77e160355e.

• Sample request

  GET https://endpoint/v1/{project_id}/demanager/instances/6fa459ea-ee8a-3ca4-894e-db77e160355e
  

• Successful sample response

  {
      "ai_project": {
          "id": "default-ai-project"
      },
      "creation_timestamp": "1594887749962",
      "description": "",
      "flavor": "modelarts.bm.gpu.v100NV32",
      "flavor_details": {
          "name": "modelarts.bm.gpu.v100NV32",
          "params": {
              "CPU": 8,
              "GPU": 1,
              "gpu_type": "v100NV32",
              "memory": "64GiB"
          },
          "status": "onSale",
          "type": "GPU"
      },
      "id": "DE-7d558ef8-c73d-11ea-964c-0255ac100033",
      "latest_update_timestamp": "1594888070775",
      "name": "notebook-c6fd",
      "profile": {
          "de_type": "Notebook",
          "description": "multi engine, gpu, python 3.6 for notebook",
          "flavor_type": "GPU",
          "id": "Multi-Engine 1.0 (python3)-gpu",
          "name": "Multi-Engine 1.0 (python3)-gpu",
          "provision": {
              "annotations": {
                  "category": "Multi-Engine 1.0 (python3)",
                  "type": "system"
              },
              "spec": {
                  "engine": "CCE",
                  "params": {
                      "annotations": null,
                      "image_name": "mul-kernel-gpu-cuda-cp36",
                      "image_tag": "2.0.5-B003",
                      "namespace": "atelier"
                  }
              },
              "type": "Docker"
          }
      },
      "spec": {
          "annotations": {
              "target_domain": "https://xxx",
              "url": "https://xxx:32000/modelarts/hubv100/notebook/user/DE-7d558ef8-c73d-11ea-964c-0255ac100033"
          },
          "auto_stop": {
              "duration": 3600,
              "enable": true,
              "prompt": true,
              "remain_time": 3336,
              "stop_timestamp": 1594891408723
          },
          "extend_params": null,
          "failed_reasons": null,
          "repository": null,
          "extend_storage": null,
          "storage": {
              "location": {
                  "path": "/home/ma-user/work"
              },
              "type": "obs"
  
          }
      },
      "status": "RUNNING",
      "user": {
          "id": "15dda26361214ca2a5953917d2f48ffb",
          "name": "ops_dev_env"
      },
      "workspace": {
          "id": "0"
      }
  }
  

• Failed sample response

  {
      "error_message": "The instance does not exist.",
      "error_code": "ModelArts.6309"
  }
  

Status Code

For details about the status code, see Status Code.

Error Codes

See Error Codes.

last updated: 2024-05-18 01:56