工作区相关接口

创建一个工作区

接口描述

创建一个 jupyter 的工作区。

请求(Request)

  • 请求语法

    POST /v{version}/workarea HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    type String 可选 工作区的类型,当前只能是 notebook,实际调用时可不填写,当为空时会默认指定为 notebook
    name String 必选 只能由数字、字母、-或_组成且首尾只能是字母,长度小于40个字符
    description String 可选 工作区的描述,支持中文 utf-8,最长 140 字符
    codeURI String 必选 用户代码存储路径,当前适配 bos 地址,bos:/bucket_name/myofile

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

    参数名 参数类型 参数描述
    workAreaId String 工作区 Id,nbs-16 位随机字符和数字

示例

  • 请求示例

    POST /v2/workarea/ HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:46:57Z/1800/host/555489ff9e6262feae5945d81f9b7abe448584d96d49b281a230dc172683bd42
    Content-Type: application/json
    Cache-Control: no-cache
    
    {
      “type”: “notebook”,
      “name”:”test01”,
      “codeURI”:”bos:/demo-infinite/tensorflow-demo”, 
      “description”:”test a test” 
    }
    
  • 响应示例

    {
        "workAreaId": "nbs-yarh0bpmzvcr454u"
    }
    

停止一个工作区

接口描述

停止一个 jupyter 的工作区。

请求(Request)

  • 请求语法

    PUT /v{version}/workarea/{workAreaId}?stop HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    workAreaId String 必选 工作区唯一标识

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

示例

  • 请求示例

    PUT /v2/workarea/nbs-yarh0bpmzvcr454u?stop HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:48:47Z/1800/host/0e1f48aea3c3a83f52f08d94f6fb8ab6855725b0acc32ea13d63d4314a3b47a4
    Content-Type: application/json
    Cache-Control: no-cache
    
  • 响应示例

启动一个工作区

接口描述

启动一个已停止 jupyter 的工作区。

请求(Request)

  • 请求语法

    PUT /v{version}/workarea/{workAreaId}?start HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    workAreaId String 必选 工作区唯一标识

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

示例

  • 请求示例

    PUT /v2/workarea/nbs-yarh0bpmzvcr454u?start HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:49:53Z/1800/host/e18999df6dfe95c379f094816d515edc29515d69900b0ed78b82d311a3f447fd
    Content-Type: application/json
    Cache-Control: no-cache
    
  • 响应示例

修改工作区配置

接口描述

更新一个 jupyter 的工作区的信息。

请求(Request)

  • 请求语法

    PUT /v{version}/workarea/{workAreaId}?update HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    workAreaId String 必选 工作区唯一标识
    name String 可选 只能由数字、字母、-或_组成且首尾只能是字母,长度小于40个字符
    description String 可选 工作区的描述,支持中文 utf-8,最长 140 字符

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

示例

  • 请求示例

    PUT /v2/workarea/nbs-yarh0bpmzvcr454u?update HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:55:06Z/1800/host/4aa5109fde89e81e89d8aa94ba0941c64daca0a97870bc50064e19bc10f484a7
    Content-Type: application/json
    Cache-Control: no-cache
    
    {
      "name": "test_02",
      "description":"update test_01 to test_02"
    }
    
  • 响应示例

删除工作区

接口描述

删除一个工作区,状态除 running 外,其他状态均可执行该操作。

请求(Request)

  • 请求语法

    DELETE /v{version}/workarea/{workAreaId} HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    workAreaId String 必选 工作区唯一标识

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

示例

  • 请求示例

    DELETE /v2/workarea/nbs-yarh0bpmzvcr454u HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T03:02:59Z/1800/host/6c7d11f7ff271f113a768af2132dc282a9d4ac73710442d6c055a760b8e7f80a
    Content-Type: application/json
    Cache-Control: no-cache
    
  • 响应示例

列出工作区列表

接口描述

列举工作区列表。

请求(Request)

  • 请求语法

    GET /v{version}/workarea?marker={marker}&maxKeys={maxKeys} HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    marker String 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys Int 可选 每页包含的最大数量,最大数量不能超过 1000。

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

    参数名 参数类型 参数描述
    marker String 标记查询的起始位置
    truncated Boolean true 表示后面还有数据,false 表示已经是最后一页
    nextMarker String 获取下一页所需要传递的 marker 值。当 truncated 为 false 时,该域不出现
    workAreaList List<WorkArea> 返回的工作区列表

示例

  • 请求示例

    GET /v2/workarea?maxKeys=2 HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:55:57Z/1800/host/328ecb574ad567033a64fa526def058a420929022d11b0e07c9c2de4c66e3a72
    Content-Type: application/json
    Cache-Control: no-cache
    
  • 响应示例

    {
        "marker": "0Y7Q-V9evcY_",
        "truncated": false,
        "workAreaList": [
            {
                "workAreaId": "nbs-yarh0bpmzvcr454u",
                "name": "test_02",
                "description": "update test_01 to test_02",
                "createTime": "2018-10-16T02:46:57Z",
                "startTime": "2018-10-16T02:50:00Z",
                "codeURI": "bos:/demo-infinite/tensorflow-demo",
                "status": "Running",
                "type": "notebook"
            }
        ]
    }
    

查看详细配置信息

接口描述

查看一个工作区的详细信息(配置相关信息)

请求(Request)

  • 请求语法

    GET /v{version}/workarea/{workAreaId} HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    workAreaId String 必选 工作区唯一标识

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

    返回WorkAreaJson 对象

示例

  • 请求示例

    GET /v2/workarea/nbs-yarh0bpmzvcr454u HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:58:03Z/1800/host/7e314c4581748e1d219262c0ebd1dc2e99fd7333944208053daec0bd8923b3ee
    Content-Type: application/json
    Cache-Control: no-cache
    
  • 响应示例

    {
        "workAreaId": "nbs-yarh0bpmzvcr454u",
        "name": "test_02",
        "description": "update test_01 to test_02",
        "createTime": "2018-10-16T02:46:57Z",
        "startTime": "2018-10-16T02:50:00Z",
        "codeURI": "bos:/demo-infinite/tensorflow-demo",
        "status": "Running",
        "type": "notebook"
    }
    

    查询访问端点

接口描述

​ 查询一个工作的访问端点信息。

请求(Request)

  • 请求语法

    GET /v{version}/workarea/{workAreaId}/endpoint HTTP/1.1
    host: infinite.{region}.baidubce.com
    Authorization: {auth}
    Content-Type: application/json
    
  • 请求头域

    无特殊 Header 参数

  • 请求参数

    参数名 参数类型 必要性 参数描述
    version String 必选 API 版本,当前为 2
    workAreaId String 必选 工作区唯一标识

响应(Response)

  • 响应头域

    无特殊Header参数响应

  • 响应参数

    参数名 参数类型 参数描述
    endpoint String 工作区的运行端点,URL,失败时为空字符串

示例

  • 请求示例

    GET /v2/workarea/nbs-yarh0bpmzvcr454u/endpoint HTTP/1.1
    host: infinite.bj.baidubce.com
    Authorization: bce-auth-v1/46e01228b2d54080907e1a33a8bd1d6c/2018-10-16T02:59:07Z/1800/host/9b8f453c44d292535d7769da5fa762b979a91d44d3318a08c3dc461cf9f5ab2e
    Content-Type: application/json
    Cache-Control: no-cache
    
  • 响应示例

    {
        "endpoint": "https://jarvis.bce.baidu.com/notebook/nbs-yarh0bpmzvcr454u/?token=604d498fae82438e947a2493f7ee15fdtk"
    }