华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作 枚举值: RETRY CANCEL OFFLINE
  • URI POST /v1/{project_id}/assets/{asset_id}/versions/{version}/action 表1 路径参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 version 是 String version 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances/{instance_name}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 task_name 是 String 子任务名称 最小长度:1 最大长度:128 instance_name 是 String 子任务实例名称 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 task_index 否 String 子任务的并发序号 缺省值:0 最小长度:1 最大长度:128 from_time 否 Long 查询监控数据起始时间,UNIX时间戳,单位毫秒,不填时默认为当前时间 to_time 否 Long 查询监控数据截止时间,UNIX时间戳,单位毫秒,不填时默认为当前时间 method 否 String 统计方法。枚举值,取值范围:maximum(最大值)、minimum(最小值)、average(平均值),不填时默认为maximum 缺省值:maximum metric_name 是 String 查询的监控指标名称
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs/{data_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 data_job_id 是 String 数据作业id 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "complete_data" : [ "demo" ], "running_data" : [ "demo" ], "creator" : "creator", "source_project_id" : "fce1376b-72f9-4d15-9f95-9b533cb988ab", "source_project_name" : "source-project", "id" : "94116a6b-1945-4581-b64c-2cea712988ab", "name" : "DataDelete-20210421093037", "sources" : [ "demo" ], "create_time" : "2021-04-21T09:30:37Z", "end_time" : "2021-04-21T09:30:37Z", "status" : "SUCCEED", "destinations" : [ "demo" ], "type" : "DELETE_DATA", "failed_reason" : "failed reason" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 complete_data Array of strings 已完成的数据列表 running_data Array of strings 正在执行的数据列表 creator String 数据作业创建者 source_project_id String 非本项目操作场景下源项目名称 source_project_name String 非本项目操作场景下源项目名称 id String 数据作业ID name String 数据作业名称 sources Array of strings 数据列表 create_time String 数据作业创建时间 end_time String 数据作业结束时间 status String 数据作业状态 destinations Array of strings 数据列表 type String 数据作业类型 failed_reason String 数据作业失败原因 additions String 附加信息
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks/{task_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 task_id 是 String 任务id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "count" : 1, "logs" : [ "Nextflow task log" ], "download_url" : "https://nextflow-cn-north-4-07d79450.obs.cn-north-4.ulanqab.huawei.com/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }
  • 响应示例 状态码: 200 OK [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" } ] 状态码: 207 MULTI_STATUS [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" }, { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2", "status" : "FAILED", "message" : "string" } ]
  • 请求示例 批量重试作业,重试如下两个作业。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-retry { "ids" : [ "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2" ] }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-retry 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 批量操作作业id列表 最小长度:1 最大长度:128 数组长度:1 - 50
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects OK 表5 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id status String 批量操作作业的结果 枚举值: SUCCEEDED FAILED message String 操作结果失败信息,仅在操作失败时会返回 状态码: 207 表6 响应Body参数 参数 参数类型 描述 [数组元素] Array of BatchOperateJobRsp objects MULTI_STATUS 表7 BatchOperateJobRsp 参数 参数类型 描述 id String 作业id status String 批量操作作业的结果 枚举值: SUCCEEDED FAILED message String 操作结果失败信息,仅在操作失败时会返回
  • 响应参数 状态码: 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 DELETE /v1/{project_id}/assets/{asset_id}/versions/{version} 表1 路径参数 参数 是否必选 参数类型 描述 asset_id 是 String 资产id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 version 是 String version 最小长度:1 最大长度:128
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 user_id 是 String 被移除项目的用户id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 查询配体相似性图计算任务成功响应。 { "status" : "finished", "result" : { "pairs" : [ { "success" : true, "ligands" : [ "FXR_74", "ligand" ], "similarity" : 0, "reason" : null } ] } }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID。 最小长度:1 最大长度:128 task_id 是 String 任务ID,通过创建任务接口取得。 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 任务状态。 result LigandSimilarityGraphTaskResultDto object 配体相似度图任务结果。 表4 LigandSimilarityGraphTaskResultDto 参数 参数类型 描述 pairs Array of LigandSimilarityGraphTaskResultPairDto objects 配体相似度图任务结果对列表。 数组长度:1 - 100 表5 LigandSimilarityGraphTaskResultPairDto 参数 参数类型 描述 ligands Array of strings 两个配体名称。 最小长度:1 最大长度:32 数组长度:2 - 2 success Boolean 相似度计算是否成功。 similarity Float 配体对之间的相似度。 最小值:0 最大值:1 reason String 相似度计算失败的理由。 最小长度:1 最大长度:512
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 镜像类型 name 否 String 镜像名称 最小长度:1 最大长度:128 show_empty 否 Boolean 是否展示无镜像版本的镜像 缺省值:true
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 镜像总数 images Array of ImageDetailRsp objects 镜像详情列表 表5 ImageDetailRsp 参数 参数类型 描述 name String 镜像名称 id String 镜像ID type String 镜像类型 chip_type String 镜像芯片类型 description String 镜像描述 tags Array of strings 镜像版本列表 create_time String 镜像创建时间 update_time String 镜像更新时间 source_project_name String 源项目名称 source_project_id String 源项目id source_resource_id String 源资源id
  • 响应示例 状态码: 200 OK { "count" : 1, "images" : [ { "name" : "demoimage", "id" : "d4fc37ee-831d-4f64-afca-e2fd05f0824d", "type" : "APP", "chip_type" : "X86", "description" : "description", "tags" : [ "v1.1" ], "create_time" : "2021-01-21T10:54:06Z", "update_time" : "2021-01-21T10:54:06Z", "source_project_name" : "demo-project", "source_project_id" : "d57g37ee-831d-4f64-afca-e2fd05f0824d", "source_resource_id" : "5f40782b-3804-4684-a009-253265dd4592" } ] }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/import 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 overwrite 否 Boolean 执行策略(true:全部覆盖,false:全部跳过,默认为true) 缺省值:true source_project_id 是 String 源项目ID 最小长度:1 最大长度:128 sub_paths 是 Array of strings 导入路径集 最小长度:1 最大长度:2000 数组长度:0 - 50 target_folder 否 String 目标文件夹 最小长度:0 最大长度:2000
  • 请求示例 导入项目数据,源目录为folder1/和folder2/test.txt,目的目录为test。 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/import { "overwrite" : true, "source_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "sub_paths" : [ "folder1/", "folder2/test.txt" ], "target_folder" : "test/" }
  • 响应示例 状态码: 200 OK { "count" : 0, "instances" : [ { "status" : { "phase" : "Failed", "pod_ip" : "192.168.0.1", "host_ip" : "192.168.0.1", "host_name" : "health-f789d9c5-e8e6-44e7-84fb-8e234bba1cee", "start_time" : "2021-01-30T02:34:36Z", "container_statuses" : [ { "restart_count" : 0 } ] }, "metadata" : { "name" : "string", "namespace" : "default" }, "spec" : { "containers" : [ { "resources" : { "limits" : { "cpu" : "string", "memory" : "string" }, "requests" : { "cpu" : "string", "memory" : "string" } } } ] } } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 实例个数 instances Array of TaskInstanceRsp objects 实例响应结构体 表5 TaskInstanceRsp 参数 参数类型 描述 status TaskInstanceStatusRsp object 实例状态信息 metadata TaskInstanceMetadataRsp object 实例元数据信息 spec TaskInstanceSpecRsp object 实例cpu和内存使用率信息 表6 TaskInstanceStatusRsp 参数 参数类型 描述 phase String 实例执行状态 pod_ip String 实例IP host_ip String 实例所在节点IP host_name String 计算节点的名称 start_time String 实例创建时间 container_statuses Array of TaskInstanceContainerStatusRsp objects 实例状态信息 表7 TaskInstanceContainerStatusRsp 参数 参数类型 描述 restart_count Integer 重启次数 表8 TaskInstanceMetadataRsp 参数 参数类型 描述 name String 实例名称 namespace String 命名空间 表9 TaskInstanceSpecRsp 参数 参数类型 描述 containers Array of TaskInstanceSpecContainersRsp objects 实例详情响应体 表10 TaskInstanceSpecContainersRsp 参数 参数类型 描述 resources TaskInstanceSpecConResourceRsp object task实例规格信息 表11 TaskInstanceSpecConResourceRsp 参数 参数类型 描述 limits TaskInstanceSpecConResLimitRsp object task资源限制值 requests TaskInstanceSpecConResRequestRsp object task资源需求值 表12 TaskInstanceSpecConResLimitRsp 参数 参数类型 描述 cpu String CPU限制值 memory String 内存限制值 表13 TaskInstanceSpecConResRequestRsp 参数 参数类型 描述 cpu String CPU申请值 memory String 内存申请值
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 task_name 是 String 子任务名称 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 task_index 否 String 子任务的并发序号 缺省值:0 最小长度:1 最大长度:128
共100000条