华为云用户手册

响应示例 状态码： 200 ok { "kind" : "job", "metadata" : { "id" : "3faf5c03-aaa1-4cbe-879d-24b05d997347", "name" : "trainjob--py14_mem06-108", "description" : "", "create_time" : 1636447346315, "workspace_id" : "0", "user_name" : "" }, "status" : { "phase" : "Abnormal", "secondary_phase" : "CreateFailed", "duration" : 0, "start_time" : 0, "node_count_metrics" : [ [ 1636447746000, 0 ], [ 1636447755000, 0 ], [ 1636447756000, 0 ] ], "tasks" : [ "worker-0" ], "running_records" : [ { "start_at" : 1701327093, "end_at" : 1701322341, "start_type" : "init_or_rescheduled", "end_recover" : "job_reschedule", "end_reason" : "exit with 127", "end_related_task" : "worker-2", "end_recover_before_downgrade" : "npu_proc_restart" }, { "start_at" : 1701323345, "end_at" : 1701325432, "start_type" : "init_or_rescheduled", "end_reason" : "job completed" } ] }, "algorithm" : { "code_dir" : "obs://test/economic_test/py_minist/", "boot_file" : "obs://test/economic_test/py_minist/minist_common.py", "inputs" : [ { "name" : "data_url", "local_dir" : "/home/ma-user/modelarts/inputs/data_url_0", "remote" : { "obs" : { "obs_url" : "/test/data/py_minist/" } } } ], "outputs" : [ { "name" : "train_url", "local_dir" : "/home/ma-user/modelarts/outputs/train_url_0", "remote" : { "obs" : { "obs_url" : "/test/train_output/" } } } ], "engine" : { "engine_id" : "pytorch-cp36-1.4.0-v2", "engine_name" : "PyTorch", "engine_version" : "PyTorch-1.4.0-python3.6-v2" } }, "spec" : { "resource" : { "flavor_id" : "modelarts.vm.pnt1.large.eco", "node_count" : 1, "flavor_detail" : { "flavor_type" : "GPU", "billing" : { "code" : "modelarts.vm.gpu.pnt1.eco", "unit_num" : 1 }, "flavor_info" : { "cpu" : { "arch" : "x86", "core_num" : 8 }, "gpu" : { "unit_num" : 1, "memory" : "8GB" }, "memory" : { "size" : 64, "unit" : "GB" } } } } } }

响应示例 状态码： 200 OK { "arch" : "x86_64", "create_at" : 1671093486722, "description" : "", "dev_services" : [ "NOTEBOOK", "SSH" ], "id" : "c9ab2b2f-edda-4556-bdbb-494e868d043c", "name" : "mock-service-python", "namespace" : "mock-service1", "origin" : "CUSTOMIZE", "resource_categories" : [ "CPU" ], "service_type" : "UNKNOWN", "size" : 387840321, "status" : "DELETED", "swr_path" : "swr.xxx.com/mock-service1/mock-service-python:0.0.17", "tag" : "0.0.17", "type" : "DEDICATED", "update_at" : 1671093486722, "visibility" : "PRIVATE", "workspace_id" : "0" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 arch String 该镜像所支持处理器架构类型。枚举值如下： X86_64：x86处理器架构。 AARCH64：ARM体系架构。 create_at Long 镜像创建的时间，UTC毫秒。 description String 该镜像所对应的描述信息，长度限制512个字符。 dev_services Array of strings 镜像支持的服务。枚举值如下： NOTEBOOK：镜像支持通过https协议访问Notebook。 SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。 id String 待创建Notebook实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考查询支持的镜像列表获取。 name String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 origin String 指定镜像来源，可选项，默认自定义构建镜像为CUSTOMIZE。枚举值如下： CUSTOMIZE：用户自定义构建镜像。 IMAGE_SAVE：Notebook实例保存镜像。 resource_categories Array of strings 镜像支持的规格。枚举值如下： CPU GPU ASCEND service_type String 镜像支持服务类型。枚举值如下： COMMON：通用镜像。 INFERENCE: 建议仅在推理部署场景使用。 TRAIN: 建议仅在训练任务场景使用。 DEV: 建议仅在开发调测场景使用。 UNKNOWN: 未明确设置的镜像支持的服务类型。 size Long 镜像大小（单位KB）。 status String 镜像状态。枚举值如下： INIT：初始化。 CREATING：镜像保存中，此时Notebook不可用。 CREATE_FAILED：镜像保存失败。 ERROR：错误。 DELETED：已删除。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建Notebook实例。 status_message String 镜像保存操作过程中，构建信息展示。 support_res_categories Array of strings 镜像支持的规格。 枚举值如下： CPU GPU ASCEND swr_path String SWR镜像地址。 tag String 镜像Tag。 type String 镜像类型。枚举值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。 update_at Long 镜像最后更新的时间，UTC毫秒。 visibility String 镜像可见度。枚举值如下： PRIVATE：私有镜像。 PUBLIC: 所有用户可以根据ImageId来进行只读使用。 workspace_id String 工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

URI GET /v2/{project_id}/workflows/{workflow_id}/subscriptions/{subscription_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID。 subscription_id 是 String 工作流的消息订阅ID。

响应示例 状态码： 200 修改工作空间配额成功的响应参数。 { "quotas" : [ { "max_quota" : 60000, "update_time" : 1574339372000, "resource" : "exemlProject.gpu_duration", "quota" : 20, "min_quota" : -1, "name_cn" : "自动学习（图像分类、物体检测、声音分类）训练时长", "unit_cn" : "分钟", "name_en" : "ExeML training duration (image classification, object detection, and sound classification)", "unit_en" : "minute" } ] }

URI PUT /v1/{project_id}/workspaces/{workspace_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workspace_id 是 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 quotas 是 Array of quotas objects 工作空间配额数据。 表4 quotas 参数 是否必选 参数类型 描述 resource 是 String 资源标识。 quota 是 Integer 要修改的配额值。配额值为正整数或-1，-1代表不限制配额。配额值范围不能超过配额的最大值与最小值。可通过调用查询工作空间配额接口查询配额的最大值。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 quotas Array of WorkspaceQuotasUpdateResponse objects 工作空间配额数据。 表6 WorkspaceQuotasUpdateResponse 参数 参数类型 描述 max_quota Integer 配额允许设置的最大值。 update_time Integer 最后修改时间，UTC。如用户未修改过该资源配额,则该值默认为该工作空间的创建时间。 resource String 资源的唯一标识。 quota Integer 当前配额值。配额值为-1代表不限制配额。 min_quota Integer 配额允许设置的最小值。 name_cn String 配额名称（中文）。 unit_cn String 数量单位（中文）。 name_en String 工作空间ID，系统生成的32位UUID，不带橫线。默认的工作空间id为'0'。 unit_en String 数量单位(英文)。

请求示例 DELETE https://endpoint/v2/{project_id }/modelarts-trainJob/{training_job_id}/tags/delete { "tags" : [ { "key" : "111", "value" : "v2" }, { "key" : "k3", "value" : "v2" } ] }

响应示例 状态码： 200 OK。 { "kind" : "NetworkList", "apiVersion" : "v1", "metadata" : { }, "items" : [ { "kind" : "Network", "apiVersion" : "v1", "metadata" : { "name" : "network-7a03-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T09:44:59Z", "labels" : { "os.modelarts/name" : "network-7a03", "os.modelarts/workspace.id" : "0" }, "annotations" : { } }, "spec" : { "cidr" : "192.168.128.0/17", "connection" : { } }, "status" : { "phase" : "Active", "connectionStatus" : { } } } ] }

URI GET /v1/{project_id}/networks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 labelSelector 否 String 标签筛选。 limit 否 Integer 分页单次查询返回数。 continue 否 String 分页查询时上一页位置。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 工作空间的总数。 count Integer 此次请求返回的工作空间个数。 workspaces Array of WorkspaceResponse objects workspace属性列表。 表5 WorkspaceResponse 参数 参数类型 描述 owner String 创建者名称。 auth_type String 授权类型。默认值为PUBLIC。 PUBLIC：租户内部公开访问。 PRIVATE：仅创建者和主账号可访问。 INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 enterprise_project_id String 企业项目ID。 update_time Integer 最后修改时间，UTC。 create_time Integer 创建时间，UTC。 enterprise_project_name String 企业项目名称。 name String 工作空间名称。 description String 工作空间描述。 id String 工作空间ID，系统生成的32位UUID，不带橫线。默认的工作空间id为'0'。 status String 工作空间状态。 CREATE_FAILED：创建失败。 NORMAL：状态正常。 DELETING：正在删除。 DELETE_FAILED：删除失败。 status_info String 状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 - String 状态码： 403 表7 响应Body参数 参数 参数类型 描述 - String 状态码： 500 表8 响应Body参数 参数 参数类型 描述 - String

响应示例 状态码： 200 查询工作空间列表成功的响应参数。 { "total_count" : 10, "count" : 1, "workspaces" : [ { "id" : 0, "name" : "default", "description" : "", "owner" : "testUser", "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "default", "auth_type" : "public", "create_time" : 1460000010000, "update_time" : 1460000010000, "status" : "NORMAL", "status_info" : "" } ] }

URI GET /v1/{project_id}/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页列表的起始页，默认为'0'。 limit 否 Integer 指定每一页返回的最大条目数，默认为'1000'。 sort_by 否 String 指定排序字段，可选'name'、'update_time'、'status'，默认是'name'。 order 否 String 可选值。'asc'为递增排序。'desc'为递减排序，默认为'desc'。 enterprise_project_id 否 String 企业项目id，指定此参数会只返回该企业项目id下的工作空间。默认显示所有工作空间。 name 否 String 工作空间名称查询参数，指定此参数会模糊查询该名称的工作空间。默认显示所有工作空间。 filter_accessible 否 Boolean 该参数用于筛选可访问的工作空间。指定该参数为true，则会筛选掉当前用户无权限访问的工作空间。该参数默认为false，即为显示所有工作空间。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 statistics statistics object 资源池统计信息。 operationTime String 统计的时间。 表4 statistics 参数 参数类型 描述 status status object 不同状态下的资源池统计信息。 表5 status 参数 参数类型 描述 creating Integer 正在创建中的资源池数量。 created Integer 创建成功的资源池数量。 failed Integer 最近三天内创建失败的资源池数量，最大值为500。 pending Integer 等待中的资源池数量，通常是未支付的包周期资源池。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK。 { "statistics" : { "status" : { "created" : 3, "creating" : 0, "failed" : 1, "pending" : 0 } }, "operationTime" : "2022-12-05 11:15:59.329633162 +0000 UTC" } 状态码： 500 Internal error { "error_code" : "ModelArts.50005000", "error_msg" : "internal error" }

URI PUT /v1/{project_id}/dev-servers/sync 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 owner 否 String 实例归属的用户ID，长度位32位小写字母、数字，在大账号/有admin权限场景下生效，值通常为当前登录用户ID。 sort_dir 否 String 排序方式，ASC升序，DESC降序。 sort_key 否 String 排序的字段，多个字段使用(“,”)逗号分割。 offset 否 Integer 分页记录的起始位置偏移量。 limit 否 Integer 每一页的数量。

响应示例 状态码： 200 OK { "current" : 0, "data" : [ { "charging_mode" : "POST_PAID", "cloud_server" : { "id" : "eb8b4e32-afc9-4f71-8372-1f55f3d7ab28", "type" : "E CS " }, "create_at" : 1699352013484, "endpoints" : [ { "service" : "SSH", "uri" : "192.168.0.23" } ], "flavor" : "Si2.large.4", "id" : "c65c4f27-f791-452b-9098-a2726fa2e922", "image" : { "arch" : "X86", "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7", "name" : "Ubuntu18.04_x86_64_CPU", "server_type" : "ECS" }, "name" : "EI-evs-01", "status" : "RUNNING", "update_at" : 1699352058465, "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172" }, { "charging_mode" : "POST_PAID", "cloud_server" : { "type" : "ECS" }, "create_at" : 1699348284990, "flavor" : "Si2.large.4", "id" : "62383738-e52a-450a-9f84-f9e705402be8", "image" : { "arch" : "X86", "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7", "name" : "Ubuntu18.04_x86_64_CPU", "server_type" : "ECS" }, "name" : "EI-evs-1107", "status" : "CREATING", "update_at" : 1699348285077 } ], "pages" : 1, "size" : 2, "total" : 2 }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建IAM用户并使用他们进行日常管理工作。 IAM用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区（AZ）是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 同样在我的凭证下，您可以查看项目ID。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

响应示例 状态码： 200 服务事件日志。 { "service_name" : "service-07085", "total_count" : 9, "service_id" : "35de3ca9-1bca-4ae7-9cb0-914f30fa7d3e", "count" : 9, "events" : [ { "event_type" : "normal", "event_info" : "start to deploy service", "occur_time" : 1562597251764 }, { "event_type" : "normal", "event_info" : "building image for model [TF 3.0.0]", "occur_time" : 1562597251788 }, { "event_type" : "normal", "event_info" : "model (TF 3.0.0) build image success", "occur_time" : 1562597251805 }, { "event_type" : "normal", "event_info" : "preparing environment", "occur_time" : 1562597255744 }, { "event_type" : "normal", "event_info" : "[TF 3.0.0] prepare environment success", "occur_time" : 1562597275915 }, { "event_type" : "normal", "event_info" : "[TF 3.0.0] schedule resource success", "occur_time" : 1562597275921 }, { "event_type" : "normal", "event_info" : "[TF 3.0.0] pulling model image", "occur_time" : 1562597275928 }, { "event_type" : "normal", "event_info" : "[TF 3.0.0] pull image success", "occur_time" : 1562597332570 }, { "event_type" : "normal", "event_info" : "[TF 3.0.0] starting model", "occur_time" : 1562597332582 } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 service_name String 服务名称。 total_count Integer 不分页的情况下符合查询条件的事件总数量。 service_id String 服务ID。 count Integer 当前查询结果的事件数量。 events Array of Events objects 服务的事件日志。 表5 Events 参数 参数类型 描述 event_type String 事件类型，取值为： normal：正常事件 abnormal：异常事件 event_info String 事件信息，当前主要描述部署过程5个阶段的信息，后续可根据情况继续补充。这5个阶段分别是构建镜像、准备环境、调度资源、拉取镜像、启动模型。 occur_time Number 事件发生时间，距“1970.1.1 0:0:0 UTC”的毫秒数。

DevServer管理接口 表22 DevServer管理接口 API 说明 查询用户所有DevServer实例详情 查询用户所有DevServer实例详情。 创建DevServer实例 创建DevServer实例。 查询DevServer实例详情 查询DevServer实例详情。 删除DevServer实例 删除DevServer实例。 实时同步用户所有DevServer实例状态 实时同步用户所有DevServer实例状态。 启动DevServer实例 启动DevServer实例。 停止DevServer实例 停止DevServer实例。

资源管理接口 表13 配置管理 API 说明 查询OS的配置参数 获取ModelArts OS服务的配置参数，如网络网段，用户资源配额等。 表14 插件模板管理 API 说明 查询插件模板 获取指定插件模板的详细信息。 表15 节点管理 API 说明 查询节点列表 查询资源池中的节点列表。 批量删除节点 批量删除指定资源池中的节点，资源池中至少保留一个节点。 表16 事件管理 API 说明 查询事件列表 查询事件列表。 表17 网络管理 API 说明 创建网络资源 创建网络资源。 查询网络资源列表 查询网络资源列表。 查询网络资源 查询指定网络资源的详情信息。 删除网络资源 删除指定网络资源。 更新网络资源 更新指定网络资源。 表18 资源指标管理 API 说明 查询资源实时利用率 查询当前项目下所有资源池的实时利用率。 表19 资源池管理 API 说明 创建资源池 用户创建资源池。 查询资源池列表 查询资源池列表。 查询资源池 查询指定资源池的详细信息。 删除资源池 删除指定的资源池。 更新资源池 更新指定的资源池。 资源池监控 获取资源池的监控信息。 资源池统计 获取资源池的统计信息。 表20 资源规格管理 API 接口 查询资源规格列表 查询资源规格列表。 表21 资源池作业管理 API 说明 查询专属资源池作业列表 查询专属资源池作业列表。 查询专属资源池作业统计信息 查询专属资源池作业统计信息。

服务管理接口 表12 服务管理接口 API 说明 部署服务 部署服务。 查询服务列表 查询服务列表。 查询服务详情 查询服务详情，根据服务ID查询服务详情。 启动停止边缘节点服务实例 启动停止边缘节点服务实例。 更新服务配置 更新模型服务。 查询服务监控信息 查询服务监控信息。 查询服务更新日志 查询实时服务更新日志。 查询服务事件日志 查询服务事件日志，包含服务的操作记录及部署过程中的关键动作、部署失败原因。 删除服务 删除服务。 查询支持的服务部署规格 查询支持的服务部署规格列表。 查询专属资源池列表 查询专属资源池列表。

APP认证管理接口 表11 APP认证管理接口 API 说明 获取APP列表 获取APIG APP基本信息列表，用户只能获取自己创建的APP信息。 创建APP 创建API网关应用（简称APP）。 查询APP详情 查询指定的APP详情。 删除APP 删除指定的APP。 增加AppCode 为指定API网关应用创建新的AppCode。 重置AppCode 重置指定API网关应用的指定的AppCode。 删除AppCode 删除指定API网关应用的指定的AppCode。 重置AppSecret 重置指定API网关应用的AppSecret。 获取用户绑定APP的api列表 获取用户绑定APP的API列表。 注册API并授权给APP 注册API并将API授权给APP。 删除API 删除指定的API，只有对API所属服务有删除权限的用户才可以删除API。 授权API至APP 将指定的API授权给APP。 更新API授权 更新API的授权关系。 解除API对APP的授权 解除指定的API对APP的授权。 获取API授权关系列表 获取指定的API与APP授权关系列表。

训练管理接口 表6 算法管理接口 API 说明 创建算法 创建一个算法。 查询算法列表 查询算法列表。 查询算法详情 根据算法ID查询指定算法。 更新算法 更新算法。 删除算法 删除算法。 查询超参搜索算法列表 查询超参搜索算法列表。 表7 训练作业管理接口 API 说明 创建训练作业 创建训练作业。 查询训练作业详情 查询训练作业详情。 更新训练作业描述 更新训练作业描述。 删除训练作业 删除训练作业。 终止训练作业 终止训练作业，只可终止创建中、等待中、运行中的作业。 查询训练作业指定任务的日志（预览） 查询训练作业指定任务的日志（预览）。 查询训练作业指定任务的日志（OBS链接） 查询训练作业指定任务的日志（OBS链接），可全量查看或直接下载。 查询训练作业指定任务的运行指标 查询训练作业指定任务的运行指标。 查询训练作业列表 根据指定查询条件查询用户创建的训练作业列表。 查询超参搜索所有trial的结果 查询超参搜索所有trial的结果。 查询超参搜索某个trial的结果 根据传入的trial_id，查询指定trial的搜索结果。 获取超参敏感度分析结果 获取超参敏感度分析结果的汇总表。 获取某个超参敏感度分析图像的路径 获取某个超参敏感度分析图像的保存路径。 提前终止自动化搜索作业的某个trial 提前终止自动化搜索作业的某个trial。 获取自动化搜索作业yaml模板的信息 获取自动化搜索作业yaml模板的信息。 获取自动化搜索作业yaml模板的内容 获取自动化搜索作业yaml模板的内容。 表8 训练作业标签管理接口 API 说明 创建训练作业标签 创建训练作业标签，支持批量添加，当添加的标签key已存在，则覆盖该标签的value。 删除训练作业标签 删除训练作业标签，支持批量删除。 查看训练作业标签 查询训练作业标签。 表9 资源和引擎规格接口 API 说明 获取训练作业支持的公共规格 获取训练作业支持的公共规格。 获取训练作业支持的AI预置框架 获取训练作业支持的AI预置框架。

开发环境接口 表5 开发环境 类型 API 说明 开发环境实例管理 查询Notebook实例列表 可按需查询满足条件的开发环境实例列表。 创建Notebook实例 根据指定的实例规格、AI引擎镜像、存储等相关参数，创建一个开发环境实例。 查询Notebook实例详情 查询开发环境实例详情。 更新Notebook实例 更新开发环境实例。 删除Notebook实例 删除开发环境实例，删除的资源包括Notebook容器以及对应的所有存储资源。 通过运行的实例保存成容器镜像 运行的实例可以保存成容器镜像，保存的镜像中，安装的依赖包（pip包）不丢失，VSCode远程开发场景下，在Server端安装的插件不丢失。 查询支持的有效规格列表 查询支持的有效规格列表。 查询支持可切换规格列表 查询Notebook实例可切换的规格列表。 查询运行中的开发环境可用时长 查询运行中的开发环境可用时长。 Notebook时长续约 延长运行中的开发环境时长。 启动Notebook实例 启动Notebook实例。 停止Notebook实例 停止Notebook实例。 动态挂载OBS 获取动态挂载OBS实例信息列表 获取动态挂载OBS实例信息列表。 动态挂载OBS 在运行态Notebook实例，动态挂载OBS。 获取动态挂载OBS实例详情 获取动态挂载OBS实例详情。 动态卸载OBS 动态卸载OBS。 标签管理 添加资源标签 给指定Notebook资源添加标签，支持批量添加，当添加的标签key已存在，则覆盖该标签的value。 删除资源标签 删除指定Notebook资源的标签，支持批量删除。 镜像管理 查询支持的镜像列表 根据指定条件分页查询满足条件的所有镜像。 注册 自定义镜像 将用户自定义的镜像注册到ModelArts镜像管理。 查询用户镜像组列表 查询用户镜像信息概览，以镜像名称作为聚合的信息。 查询镜像详情 查询镜像详情。 删除镜像 删除镜像对象，对于个人私有镜像可以通过参数一并删除SWR镜像内容。

工作流管理 表1 Workflow API 说明 获取Workflow列表 获取Workflow列表信息。 新建Workflow 创建Workflow。 删除Workflow 通过ID删除Workflow。 查询Workflow 通过ID查询Workflow详情。 修改Workflow 更新Workflow信息。 总览Workflow 获取Workflow统计信息。 查询Workflow待办事项 获取Workflow待办列表。 在线服务鉴权 计费工作流在线主服务鉴权。 创建在线服务包 计费工作流购买资源。 表2 WorkflowExecution API 说明 获取Execution列表 查询Workflow下的执行记录列表。 新建Workflow执行 创建工作流执行。 删除Execution 通过ID删除Execution。 查询Execution 通过ID，查询Execution详情。 更新Execution 通过ID更新Execution。 操作Execution 操作Execution。 操作StepExecution 操作STEP。 获取工作流节点度量信息 获取工作流节点的度量信息。 表3 WorkflowSubscription API 说明 新建消息订阅 创建工作消息订阅。 删除Subscription 删除消息订阅。 查询Subscription详情 查询订阅信息。 更新Subscription 更新订阅信息。 表4 WorkflowSchedule API 说明 创建工作流定时调度 创建Workflow定时调度。 查询工作流定时调度详情 查询工作流调度详情。 删除工作流定时调度信息 删除工作流调度信息。 更新工作流定时调度信息 更新WorkflowSchedule信息。

响应示例 状态码： 201 OK { "created_at" : "2022-11-01T21:36:04.310635+08:00", "uuid" : "2f7ad04a-60cb-4f1c-96fd-dfc9cf96363b", "instance_id" : "{\"model_id\":\"6fe56a95-e7f1-4388-b207-c80684af0cb8\"}", "step_name" : "model_step", "step_title" : "model release", "status" : "completed", "duration" : 15, "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input", "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" } } ], "outputs" : [ { "name" : "model_output", "type" : "model", "config" : { "model_id" : "6fe56a95-e7f1-4388-b207-c80684af0cb8" } } ], "properties" : { "model_name" : "lh-xh", "model_type" : "TensorFlow" }, "events" : [ "2022-11-01 21:36:05 change status from init to creating", "2022-11-01 21:36:09 change status from creating to created", "2022-11-01 21:36:09 change status from created to running", "2022-11-01 21:36:19 change status from running to completed" ], "policy" : { } }

请求示例 停止step POST https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/executions/4dd2a2f5-bde2-45dd-af6b-5e5d570118d1/step_executions/255a1079-b00a-4c3a-8218-3458f7546b8d/actions { "action_name" : "stop" }