创建DSW实例

基础信息

资源信息

环境信息

# 修改不会生效
USER_NAME # 会被service里的逻辑覆盖

# 不建议修改的系统变量，修改可能会影响正常使用
JUPYTER_NAME：默认由实例信息构造而来，可用于修改jupyterlab的url访问路径
JUPYTER_COMMAND: jupyter启动指令,默认设置为lab用于启动jupyterlab
JUPYTER_SERVER_ADDR: jupyterlab服务监听地址，默认为0.0.0.0
JUPYTER_SERVER_PORT: jupyterlab服务监听端口，默认为8088
JUPYTER_SERVER_AUTH: jupyterlab访问密码，默认为空
JUPYTER_SERVER_ROOT: jupyter工作目录，优先级不如WORKSPACE_DIR高
CODE_SERVER_ADDR: code-server服务监听地址，默认为0.0.0.0
CODE_SERVER_PORT: code-server服务监听端口，默认为8082
CODE_SERVER_AUTH: code-server访问密码，默认为空
WORKSPACE_DIR: 系统根据实例新建时设置的工作目录参数设定这个环境变量。可改变jupyter、code-server的启动目录。如果路径不存在可能报错。

网络信息

访问配置

角色与权限

DSW实例启动常见问题

DSW实例停止或释放常见问题

1. 阿里云 SDK 通过 Credentials 工具获取凭证信息。调用 API 前，请先安装并配置该工具。要求：

   • Python版本 >= 3.7。

   • 使用V2.0代系的阿里云SDK。

   安装命令如下：

   pip install alibabacloud_credentials

2. 获取账号AccessKey。本示例使用AK信息配置访问凭证，为防止账号信息泄露，建议您将AccessKey配置为环境变量，id和secret环境变量名分别为ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET。

   • 获取AccessKey信息，请参见创建AccessKey。

   • 如何设置环境变量，请参见配置环境变量。

   • 其它Credentials凭证配置方式，请参见安装Credentials工具。

3. 安装PAI相关Python SDK。

   # 工作空间SDK安装。
   pip install alibabacloud-aiworkspace20210204 -U -q
   # DSW SDK安装。
   pip install alibabacloud_pai_dsw20220101 -U -q
   # OpenAPI依赖。
   pip install alibabacloud_tea_openapi -U -q
   # 预付费资源组查询SDK安装。
   pip install https://sdk-portal-us-prod.oss-accelerate.aliyuncs.com/downloads/u-b8602de7-c468-436c-8a02-2eca4a30d376-python-paistudio.zip -U -q

4. 创建一个DSW实例。

   创建实例的代码示例

   import os
   
   from alibabacloud_aiworkspace20210204.client import Client as AIWorkspaceClient
   from alibabacloud_aiworkspace20210204.models import (ListWorkspacesRequest,
                                                        ListImagesRequest)
   from alibabacloud_credentials.client import Client
   from alibabacloud_credentials.models import Config
   from alibabacloud_pai_dsw20220101.client import Client as DSWClient
   from alibabacloud_pai_dsw20220101.models import (GetInstanceRequest,
                                                    ListEcsSpecsRequest,
                                                    CreateInstanceRequest)
   from alibabacloud_tea_openapi.client import TeaException
   from alibabacloud_tea_openapi.models import Config as AliyunConfig
   
   # 配置访问凭证
   # 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
   # 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码中，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
   # 本示例通过Credentials SDK默认从环境变量中读取AccessKey进行身份验证。
   region_id = 'cn-beijing'  # Region，可以是cn-hangzhou、cn-shanghai、cn-shenzhen等。
   config = Config(
       type='access_key',
       access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
       access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
   )
   cred = Client(config)
   # client config。
   workspace_client = AIWorkspaceClient(
       config=AliyunConfig(
           credential=cred,
           region_id=region_id,
           endpoint="aiworkspace.{}.aliyuncs.com".format(region_id),
       )
   )
   dsw_client = DSWClient(
       config=AliyunConfig(
           credential=cred,
           region_id=region_id,
           endpoint='pai-dsw.{}.aliyuncs.com'.format(region_id),
       )
   )
   
   
   # 定义一个用来显示DSW实例信息的Helper函数。
   def show_instance(instance_id):
       instance = dsw_client.get_instance(instance_id=instance_id, request=GetInstanceRequest()).body
       print(instance.status, instance.instance_name, instance.ecs_spec, instance.accumulated_running_time_in_ms)
   
   
   # 查询一个已经存在的工作空间（Workspace）的属性和ID。
   workspace_name = '已有的AI工作空间名称'
   # 获取工作空间列表。
   workspaces = workspace_client.list_workspaces(ListWorkspacesRequest(
       page_number=1,
       page_size=10,
       workspace_name=workspace_name,  # 模糊匹配，如果未指定名称，则返回所有workspace。
   ))
   if len(workspaces.body.workspaces) == 0:
       raise RuntimeError('请指定正确的workspace_name')
   for workspace in workspaces.body.workspaces:
       print(workspace.workspace_name,
             workspace.workspace_id,
             workspace.status, workspace.creator)
   # 使用查询到的第一个结果作为后续操作的工作空间，您可以按需切换或者直接指定一个字符串类型的ID。
   workspace_id = workspaces.body.workspaces[0].workspace_id
   # 获取镜像列表，可以使用labels进行过滤。
   images = workspace_client.list_images(ListImagesRequest(
       page_size=100,
       # workspace_id=workspace_id, #不指定workspace_id则意味着查询所有PAI平台内置的镜像
       labels=','.join(['system.supported.dsw=true',
                        # 'system.framework=tensorflow', #指定pytorch或者tensorflow
                        'system.pythonVersion=3.6',
                        ]),
       verbose=True  # verbose=True会列出更加详细的信息，包括labels
   ))
   # 可以查看所有可用的镜像。
   for image in images.body.images:
       print(image.image_id, image.image_uri)
   # 获得用于提交任务所使用的镜像，这里取第一个作为示例。
   image_uri = images.body.images[0].image_uri
   print('image_uri', image_uri)
   # 获取DSW的节点规格列表。
   try:
       resp = dsw_client.list_ecs_specs(ListEcsSpecsRequest(accelerator_type='CPU',  # CPU 或者 GPU
                                                            )).body
   except TeaException as t:
       print("List ECS Specs failed:", t.message)
   else:
       for spec in resp.ecs_specs:
           print(spec.instance_type + ", CPU: " + str(spec.cpu) + ", Memory: " + str(spec.memory))
       # 获得用于提交任务的节点规格。
       ecs_spec = resp.ecs_specs[0].instance_type
       print('Selected ecs_spec:', ecs_spec)
   
   # 创建DSW实例。
   request = CreateInstanceRequest(instance_name="Test_From_SDK_1",
                                   ecs_spec=ecs_spec,
                                   workspace_id=workspace_id,
                                   # image_id='', #可以指定工作空间中的镜像的ID，但是与image_url只能指定一个参数
                                   image_url=image_uri)
   try:
       ins_resp = dsw_client.create_instance(request)
   except TeaException as t:
       print('创建实例失败，错误消息：' + t.message)
   else:
       instance_id = ins_resp.body.instance_id
       print("Created Instance ID:", instance_id)
       show_instance(instance_id)                           

关于更多接口的说明，请参见API概览。