Help Center> ModelArts> API Reference> Development Environment> Querying the Details About a Development Environment Instance
View PDF

Querying the 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 Parameter description

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 Parameter description

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 definition For details about parameters of a notebook instance, see Table 10.

workspace

Object

Workspace. For details, see Table 12.

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

error_code

String

Error code. For details, see Error Code.

queuing_info

Object

Queuing information. For details, see Table 13.

user

Object

User information. For details, see Table 14.

repository

Object

Git repository information. This parameter cannot be used. It is automatically returned when the API is called.
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. Currently, only notebook is supported.

provision

Object

Deployment information. For details, see Table 4.

labels

Object

Label information

flavor_type

String

Hardware, including CPU, GPU, and Ascend.
Table 4 provision parameters

Parameter

Type

Description

type

String

Deployment type. Currently, only Docker is supported.

spec

Object

Deployment details. For details, see Table 5.

annotations

Object

Label information, which can be extended. By default, this parameter is left blank.
Table 5 spec parameters

Parameter

Type

Description

engine

String

Deployment engine. Currently, only CCE is supported.

params

Object

Deployment parameters. Currently, 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

Object

Label information, which can be extended. By default, this parameter is left blank.
Table 7 flavor_details parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Flavor name

status

Yes

String

Flavor sale status The options are as follows:

  • onSale
  • soldOut

queuing_num

No

Integer

This parameter is mandatory when promo_type is set to Free and status is set to soldOut.

queue_left_time

No

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

No

List< storageType >

Supported storage type. The options are obs, evs, and efs.

is_permitted

No

String

Whether the current user has the permission to use this flavor

type

Yes

String

Flavor status. The options are as follows:

  • GPU
  • CPU
  • ASCEND

params

Yes

Dict

Parameters that describing flavor

promo_type

No

String

Promotion type. The options are as follows:

  • Free
  • NoDiscount

instance_num

No

Integer

Number of instances of this flavor the current created

duration

No

Integer

Auto stop time after startup, in seconds

store_time

No

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

No

String

Billing specifications. If this field is left blank, the specifications name is used for billing.

billing_params

No

Integer

Billing ratio This parameter is mandatory when billing_flavor is specified.
Table 8 pool parameters

Parameter

Mandatory

Type

Description

id

Yes

String

ID of a resource pool

name

No

String

Name of a resource pool

type

No

String

Type of a resource pool. USER_DEFINED indicates a dedicated resource pool.

owner

No

Dict

This parameter is mandatory when type is set to USER_DEFINED. For details, see Table 9.
Table 9 owner parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 10 notebook parameters

Parameter

Type

Description

storage

Object

Storage path

auto_stop

Object

Auto stop parameter. For details, see Table 11.

annotations

Object

Annotations

The generated URL cannot be directly accessed.
Table 11 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 12 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 13 queuing_info parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Instance ID

name

No

String

Instance name

de_type

No

String

Development environment type. By default, all types are returned.

Currently, only the notebook is supported.

flavor

No

String

Instance flavor. By default, all types are returned. Currently, the options are as follows:

  • modelarts.vm.cpu.free
  • modelarts.vm.gpu.free

flavor_details

No

Object

Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 7.

status

Yes

String

Instance status. By default, all statuses are returned, including:

  • CREATE_QUEUING
  • START_QUEUING

begin_timestamp

Yes

Integer

Time when an instance starts queuing. The value is a 13-digit timestamp.

remain_time

Yes

Integer

Left queuing time, in seconds

end_timestamp

No

Integer

Time when an instance completes queuing. The value is a 13-digit timestamp.

rank

Yes

Integer

Ranking of an instance in a queue
Table 14 user parameters

Parameter

Type

Description

id

String

User ID

name

String

Username

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": "Python3-gpu",
        "name": "Python3",
        "provision": {
            "annotations": {
                "category": "Multi-Engine (Recommend)",
                "flavor": "modelarts.vm.gpu.p100",
                "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://modelarts-notebook-2.cn-north-4.myhuaweicloud.com",
            "url": "https://modelarts-lvs-common-lb.cn-north-4.myhuaweicloud.com:32000/modelarts/cn-north-4/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,
        "storage": {
            "location": {
                "path": "/home/ma-user/work",
                "volume_size": 5,
                "volume_unit": "GB"
            },
            "type": "evs"
        }
    },
    "status": "RUNNING",
    "user": {
        "id": "15dda26361214ca2a5953917d2f48ffb",
        "name": "ops_dev_env"
    },
    "workspace": {
        "id": "0"
    }
}
  • Failed sample response 
    {
    "error_msg": "The instance does not exist.",
    "error_code": "ModelArts.6309"
}

Status Code

For details about the status code, see Status Code.

Parent topic: Development Environment