华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 个数 projects Array of ProjectRsp objects 项目详情列表 表4 ProjectRsp 参数 参数类型 描述 id String 项目id name String 项目名称 creator String 项目所有者 role String 当前用户在该项目上的角色 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 核心项目标记

响应示例 状态码： 200 OK { "count" : 1, "resources" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "instance", "spec" : { "code" : "code", "name" : "name" }, "availability_zone_id" : "cn-north-7c", "space" : 65, "free_space" : 30, "charge_mode" : 1, "period_num" : 1, "job_quota" : 8, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of PerformanceResourceRsp objects 性能加速资源列表 表4 PerformanceResourceRsp 参数 参数类型 描述 id String 实例ID resource_id String 资源ID name String 实例名称 spec SpecDto object 规格信息 availability_zone_id String 可用区 space Integer 最大容量, 单位GB free_space Double 可用容量，单位GB charge_mode String 计费模式 period_num Integer 购买周期 running_job_count Integer 作业运行数 job_quota Integer 运行的最大作业数量 create_time String 购买时间 failure_reason String 失败原因 status String 状态 schedulable Boolean 资源是否可调度 表5 SpecDto 参数 参数类型 描述 code String 规格编号 最大长度：64 name String 规格名称 最大长度：64

响应示例 状态码： 200 OK { "count" : 1, "performance_resources" : [ { "id" : "0025ec57-9403-4a67-ae5f-ff79ffa847f7", "name" : "sfs-9403-4a67", "running_job_count" : 1, "schedulable" : true } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 性能加速资源总数 performance_resources Array of PerformanceResourcesRsp objects 性能加速资源信息 表5 PerformanceResourcesRsp 参数 参数类型 描述 id String 性能加速资源id name String 性能加速资源名称 running_job_count Integer 当前运行中的作业总数 schedulable Boolean 资源是否可调度

URI GET /v1/{project_id}/eihealth-projects/performance-resources-statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000] 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000] 最小值：0 最大值：100000000 缺省值：0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据（文件夹、文件）总数量 objects Array of BucketObjectDto objects 数据列表 表5 BucketObjectDto 参数 参数类型 描述 path String 对象全路径（项目名称:/路径） name String 名称 type String 类型 枚举值： FILE FOLDER size Long 大小 create_time String 创建时间

响应示例 状态码： 200 OK { "count" : 1, "objects" : [ { "path" : "bucket:/test.txt", "name" : "test.txt", "type" : "FILE", "size" : 1024, "create_time" : "2021-02-01T14:25:34Z" } ] }

URI GET /v1/{project_id}/customer-buckets/{bucket_name}/objects 表1 路径参数 参数 是否必选 参数类型 描述 bucket_name 是 String 桶名称 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量，单次查询总量[1, 1000]，默认100 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 偏移量，查询起始偏移，默认为0 最小值：0 最大值：100000000 缺省值：0 path 否 String 子路径 最小长度：0 最大长度：2000 search_key 否 String 查询关键词 最小长度：0 最大长度：2000

响应示例 状态码： 200 OK { "total_count" : 100, "unread_count" : 50, "notices" : [ { "id" : 123456, "type" : "RESOURCE", "is_read" : true, "detail" : "notice detail", "create_time" : "2022-11-24 09:33:56" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 通知消息总数 unread_count Integer 通知消息未读总数 notices Array of NoticeRsp objects 通知消息列表 表5 NoticeRsp 参数 参数类型 描述 id String 消息id type String 消息类型 detail String 消息详情 create_time String 消息创建时间 is_read Boolean 是否已读

URI GET /v1/{project_id}/notices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 is_read 否 Boolean 消息状态是否已读，true返回已读，false返回未读，不填返回全部 limit 否 Integer 查询条数 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 查询偏移量 最小值：0 最大值：100000000 缺省值：0

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks/tools 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "count" : 1, "notebooks" : [ { "id" : "DE-7d558ef8-c73d-11ea-964c-0255ac100033", "name" : "notebook-example", "description" : "notebook description in here", "creator" : "notebook_creator", "url" : "https://0.0.0.0:0000/0951eb641.../notebook/e4a3b97a.../services/notebook", "flavor" : { "cpu" : "1", "gpu" : "0", "memory" : "100" }, "status" : "Running", "image" : { "image_type" : "SYSTEM", "image_info" : { "source_project_name" : "eihealth-project", "image_name" : "eihealth-notebook", "image_tag" : "3.1.0-latest", "profile" : "PY3" } }, "storages" : [ { "path" : "project_name:/example", "mount_path" : "/example" } ], "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z", "failed_message" : "failed massage in here" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer notebook总数 notebooks Array of NotebookEntity objects notebook详情列表 表5 NotebookEntity 参数 参数类型 描述 id String notebook ID name String notebook名称 description String notebook描述 creator String notebook所属用户 url String notebook访问URL flavor FlavorInfo object notebook规格 status String notebook状态 枚举值： Running Abnormal Hibernate Succeeded Creating Deleting Updating CreatedFailed DeletedFailed UpdatedFailed Unknown image NotebookImage object notebook镜像信息 storages Array of NotebookStorage objects notebook存储信息 create_time String notebook创建时间 update_time String notebook更新时间 failed_message String notebook失败信息 events Array of TaskEventRsp objects cce事件 表6 FlavorInfo 参数 参数类型 描述 cpu Float notebook占用的cpu,0.1核为100m,单位为"C" 最小值：1 最大值：128 缺省值：1 gpu Float notebook占用的gpu，0.1为使用单卡10%，1为占满单个显卡，1+为使用多个显卡 最小值：0 最大值：16 缺省值：0 memory Float notebook占用的内存,单位为"G" 最小值：2 最大值：512 缺省值：2 表7 NotebookImage 参数 参数类型 描述 image_type String 镜像类型 枚举值： SYSTEM CUSTOMER image_info ImageInfo object 镜像信息 表8 ImageInfo 参数 参数类型 描述 source_project_name String 源项目名 最小长度：1 最大长度：128 image_name String 镜像名 最小长度：1 最大长度：128 image_tag String 镜像tag名 最小长度：1 最大长度：64 profile String 系统镜像名 枚举值： PY3 表9 NotebookStorage 参数 参数类型 描述 path String notebook存储路径 最小长度：1 最大长度：4096 mount_path String 挂载路径，由于目前暂不支持自定义挂载，暂不开放 最小长度：1 最大长度：4096 表10 TaskEventRsp 参数 参数类型 描述 type String 任务启动事件类型 count Integer 任务启动事件发生次数 reason String 任务启动事件状态 message String 任务启动事件详细信息 first_timestamp String 任务启动事件首次上报时间 last_timestamp String 任务启动事件末次上报时间

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 读取条数 最小值：1 最大值：1000 缺省值：100 name 否 String notebook名称 最小长度：1 最大长度：200 offset 否 Integer 读取偏移量 最小值：0 最大值：100000000 缺省值：0 status 否 String notebook状态

URI GET /v1/{project_id}/system/autoscaler/scale-out-policies/{id}/computing-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 id 是 String 策略id 最小长度：1 最大长度：128

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 workflows Array of NextflowWorkflowListDto objects 当前页的流程列表 count Integer 所查询类型的流程总数 表5 NextflowWorkflowListDto 参数 参数类型 描述 id String 流程id name String 流程名称 description String 描述信息 labels Array of strings 流程标签 create_time String 创建流程时间 update_time String 更新流程时间 creator String 创建用户名称 source_project_name String 源项目名称 source_resource_id String 源资源id

响应示例 状态码： 200 OK { "workflows" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-workflow", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "creator" : "test-01", "source_project_name" : "src", "source_resource_id" : "src-id" } ], "count" : 1 }

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 流程名称 最小长度：1 最大长度：56

响应示例 状态码： 200 OK { "count" : 1, "tasks" : [ { "task_id" : "1", "process" : "convertToUpper", "tag" : "\"process_tag\"", "hash" : "45/39c703", "status" : "COMPLETED", "container" : "127.0.0.1:8080/hwofficial/coredns:1.23.2", "pod_name" : "nf-322decb1e97bfcaba3b6672b73551206", "submit" : 1675756197305, "complete" : 1675756199000, "duration" : 1695, "realtime" : 82, "cpu_percent" : 42.0, "mem_percent" : 32.0 } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 tasks Array of NextflowTaskListDto objects 子任务实例 count Integer 子任务的总数 表5 NextflowTaskListDto 参数 参数类型 描述 task_id String 子任务id process String 流程名称 tag String 子任务标识符 hash String 哈希值 status String 子任务状态 container String 容器名称 pod_name String pod名称 submit String 提交时间 complete String 完成时间 duration Long 总时间 realtime Long 实际运行时间 cpu_percent Double cpu使用率 mem_percent Double 内存使用率

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 job_id 是 String 作业id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 search_key 否 String 模糊搜索值 最小长度：0 最大长度：1024

响应示例 状态码： 200 OK { "count" : 1, "jobs" : [ { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo-job", "description" : "description", "status" : "COMPLETED", "has_ignore_failed_tasks" : false, "create_time" : "2021-01-30T02:34:36Z", "finish_time" : "2021-01-30T02:53:26Z", "user_name" : "demo-user", "workflow_name" : "demo-workflow", "workflow_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of NextflowJobListDto objects 作业列表 count Integer 作业总数 表5 NextflowJobListDto 参数 参数类型 描述 id String 作业id name String 作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-) description String 作业的描述,取值范围：输入字符最大长度为255 labels Array of strings 作业标签 status String 作业状态 has_ignore_failed_tasks Boolean 是否包含已被忽略的失败tasks create_time String 作业创建时间 finish_time String 作业结束时间 failed_message String 失败提示，当作业执行失败时会返回 failed_reason String 失败原因，当作业执行失败时会返回 user_name String 创建任务的用户名称 workflow_name String 流程名称 workflow_id String 流程id

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000] 最小值：1 最大值：1000 缺省值：100 offset 否 Integer 偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000] 最小值：0 最大值：100000000 缺省值：0 sort_dir 否 String 排序规则 目前默认时间降序 缺省值：DESC sort_key 否 String 排序规则目前默认时间降序，支持根据status job_name 否 String 作业名称 最小长度：1 最大长度：128 labels 否 Array 标签列表 最小长度：1 最大长度：32 数组长度：0 - 5 status 否 String 作业运行状态 取值（SUBMITTED|RUNNING|COMPLETED|FAILED|CANCELLED|UNKNOWN） workflow_name 否 String workflow名称 最小长度：1 最大长度：128 user_name 否 String 作业创建者 最小长度：1 最大长度：128 create_start_time 否 Long 最小创建时间 最小值：1000000000000 最大值：9999999999999 create_end_time 否 Long 最大创建时间 最小值：1000000000000 最大值：9999999999999 finish_start_time 否 Long 最小结束时间 最小值：1000000000000 最大值：9999999999999 finish_end_time 否 Long 最大结束时间 最小值：1000000000000 最大值：9999999999999

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 消息总数 messages Array of MessageRsp objects 消息列表 表5 MessageRsp 参数 参数类型 描述 message_type String 消息类型 eihealth_project_name String 项目名称 resource_type String 资源类型 resource_name String 资源名称 operator String 操作用户 status String 状态 operate_time String 操作时间 message_detail String 详情

URI GET /v1/{project_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 eihealth_project_name 否 String 医疗智能体 项目名 最小长度：1 最大长度：128 limit 否 Integer 查询条数 最小值：1 最大值：1000 缺省值：100 message_type 否 String 消息类型 最小长度：1 最大长度：128 offset 否 Integer 查询偏移量 最小值：0 最大值：100000000 缺省值：0 operator 否 String 操作者名称 最小长度：1 最大长度：128 resource_type 否 String 资源类型 最小长度：1 最大长度：128 status 否 String 操作状态 最小长度：1 最大长度：128

响应示例 状态码： 200 OK { "count" : 1, "messages" : [ { "message_type" : "PROJECT_DELETE", "eihealth_project_name" : "project-example-01", "resource_type" : "workflow_resource", "resource_name" : "WORKFLOW", "operator" : "operator-example-01", "status" : "SUCCEEDED", "operate_time" : "2021-01-15T02:45:38Z", "message_detail" : "message detail" } ] }

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/label-pages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128