华为云用户手册

  • URI GET /v1/{project_id}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 表2 Query参数 参数 是否必选 参数类型 描述 from_time 否 Long 查询监控数据起始时间,UNIX时间戳,单位毫秒,不填时默认为当前时间 to_time 否 Long 查询数据截止时间,UNIX时间戳,单位毫秒,不填时默认为当前时间 period 否 String 监控数据周期。枚举值,取值范围:real_time(实时数据)、five_minutes(5分钟粒度)、fifteen_to_twenty_minutes(15-20分钟粒度)、one_hour(1小时粒度),不填时默认为real_time 缺省值:real_time method 否 String 统计方法。枚举值,取值范围:max(最大值)、min(最小值)、average(平均值),不填时默认为max 缺省值:max metric_name 是 String 查询的监控指标名称,取值范围: node_cpu_util node_mem_util node_disk_util node_network_incoming_bytes_rate_inband node_network_outgoing_bytes_rate_inband node_total_cpu_util node_total_mem_util node_total_allocatable_cpu_util node_total_allocatable_mem_util node_bms_gpu_decoder_utilization node_bms_gpu_encoder_utilization node_bms_gpu_memory_total node_bms_gpu_memory_usage node_bms_gpu_memory_used node_bms_gpu_power_draw node_bms_gpu_temperature node_bms_gpu_utilization node_gpu_utilization node_gpu_memory_usage performance_data_read_io_bytes performance_data_write_io_bytes performance_total_io_bytes performance_iops database_cpu_util database_mem_util database_bytes_in database_bytes_out database_iops storage_download_bytes storage_upload_bytes storage_request_count_get_per_second storage_request_count_put_per_second storage_request_count_delete_per_second storage_request_count_per_second storage_capacity_total storage_object_num_all storage_download_extranet_bytes resource_id 否 String 查询的监控资源对象id,当查询存储资源和计算节点资源中的集群监控数据时,不需要填写资源id 最小长度:1 最大长度:128 device_id 否 String 显卡id,仅查询裸金属节点的gpu监控时,需要指定 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "count" : 1, "resources" : [ { "spec" : { "code" : "code", "name" : "name" }, "size" : 1024, "charge_mode" : 2, "create_time" : "2021-02-01T14:25:50Z", "status" : "Deploying" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数 resources Array of StorageResourceRsp objects 存储资源列表 表4 StorageResourceRsp 参数 参数类型 描述 spec SpecDto object 规格信息 size Long 已用量 charge_mode String 计费模式 create_time String 购买时间 status String 状态,取值范围: Deploying Normal Updating Abnormal Freeze Deleting 表5 SpecDto 参数 参数类型 描述 code String 规格编号 最大长度:64 name String 规格名称 最大长度:64
  • API概览 医疗智能体 平台所提供的API,均符合RESTful API设计规范,如表1所示。 临床研究和药物设计所提供的API,均符合RESTful API设计规范,如表2所示。 表1 医疗智能体平台API 类型 API 说明 项目管理 项目管理 项目创建、获取项目详情、删除项目等相关操作API。 系统管理 系统管理 系统设置、系统资源、用户管理、消息中心、标签等相关操作API。 镜像管理 镜像管理 导入镜像、更新镜像、创建镜像、删除镜像等相关操作API。 数据管理 数据管理 数据归档、数据管理等相关操作API。 数据库管理 数据库管理 数据库管理、模板管理等相关操作API。 应用管理 应用管理 导入应用、创建应用、获取应用详情、删除应用等相关操作API。 流程管理 流程管理 导入流程、创建流程、获取流程详情、删除流程等相关操作API。 作业管理 作业管理 启动作业、获取作业详情、停止作业等相关操作API。 资产市场 资产市场 资产管理、资产收藏、供应商管理等相关操作API。 开发环境 notebook开发环境 Notebook开发环境创建、更新、删除等相关操作API。 虚拟药物筛选 虚拟药物筛选 创建study、列举study、删除study等相关操作API。 表2 临床研究、AI辅助药物设计API 类型 API 说明 药物设计 API(AI辅助药物设计) 分子生成、分子优化、靶点化合物结合预测、分子属性预测相关操作API。
  • 终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询服务的终端节点。 医疗智能体平台的终端节点如表1所示,药物设计、临床研究的终端节点如表2所示,请您根据业务需要选择对应区域的终端节点。 表1 终端节点(医疗智能体平台API) 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 eihealth.cn-north-4.myhuaweicloud.com eihealth.cn-north-4.myhuaweicloud.cn HTTPS 华东-上海一 cn-east-3 eihealth.cn-east-3.myhuaweicloud.com eihealth.cn-east-3.myhuaweicloud.cn HTTPS 华南-广州 cn-south-1 eihealth.cn-south-1.myhuaweicloud.com eihealth.cn-south-1.myhuaweicloud.cn HTTPS 表2 终端节点(AI辅助药物设计API、临床研究API) 区域名称 区域 终端节点(Endpoint) 协议类型 华东-上海一 cn-east-3 eihealth-api.cn-east-3.myhuaweicloud.com eihealth-api.cn-east-3.myhuaweicloud.cn HTTPS 表3 终端节点(医学影像) 区域名称 区域 终端节点(Endpoint) 协议类型 华南-广州 cn-south-1 eihealth.cn-south-1.myhuaweicloud.com HTTPS 父主题: 使用前必读
  • 概述 欢迎使用医疗智能体( EIHealth )平台,该服务基于华为云AI和大数据技术优势,为基因组分析、药物研发和临床研究三个领域提供的专业AI研发平台。平台提供大量相关模型、算法及数据资源,是一站式的医疗研发平台。EIHealth以开放API的方式提供给用户,您可以根据本文档提供的API来使用服务,支持的全部API请参见API概览。 在调用医疗智能体平台API之前,请确保已经充分了解医疗智能体平台的相关概念,详细信息请参见产品介绍和用户指南。 您可以使用本文档提供的API对EIHealth平台的资源进行相关操作。 父主题: 使用前必读
  • 请求示例 创建项目,设置描述、名称、标签 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects{ "description" : "this is a demo project", "name" : "demo-project", "tags" : [ "tag" ] , "is_core" : true }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述。 最小长度:0 最大长度:1024 name 是 String 项目名称。 仅支持小写字母、数字、中划线(-)、下划线(_),开头和结尾只能是数字或字母。 最小长度:3 最大长度:45 tags 否 Array of strings 标签。支持添加0~5个标签。 最小长度:1 最大长度:32 is_core 否 Boolean 是否为核心项目标记 缺省值:true
  • 请求示例 预测一个分子的ADMET属性 { "smiles" : "c1ccccc1", "custom_props" : [ { "id" : "3b2dce64-c244-11ed-acf5-0255ac100017", "prop_definition" : { "id" : "c4c07032d1934671a0dfe3bd10416eea", "name" : "custom_prop_name", "type" : "numerical", "description" : "custom_prop_description" } } ]}
  • 响应示例 状态码: 200 ADMET成功响应 { "custom_props" : [ { "id" : "3b2dce64-c244-11ed-acf5-0255ac100017", "prop_definition" : { "id" : "c4c07032d1934671a0dfe3bd10416eea", "name" : "custom_prop_name", "type" : "numerical", "description" : "custom_prop_description" } } ], "props" : { "ab" : "base", "acute_toxicity_rule" : 0, "alarm_nmr_rule" : 0, "ames" : 4.555075065582059E-6, "3b2dce64-c244-11ed-acf5-0255ac100017" : 0.85 }}
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 custom_props Array of CustomProp objects 用户已开启的自定义属性集合 props Object 分子ADMET属性字典(包含自定义属性) 表8 CustomProp 参数 参数类型 描述 id String 自定义属性的ID(API侧) 最小长度:1 最大长度:64 prop_definition PropDefinition object 属性定义的元信息 表9 PropDefinition 参数 参数类型 描述 id String 属性业务侧ID 最小长度:1 最大长度:128 name String 属性名称 最小长度:1 最大长度:32 type String 属性类型 枚举值: binary numerical description String 属性具体描述信息 最小长度:0 最大长度:256 value_range ValueRange object 属性有效值域区间 optimal_range ValueRange object 属性最优值域区间 warning_range ValueRange object 属性欠佳值域区间 style String 模型参数呈现类型 枚举值: number probability confidential_interval Boolean 模型推理是否呈现置信区间 表10 ValueRange 参数 参数类型 描述 lower Number 值域下限 lower_inclusive Boolean 是否包含值域下限 upper Number 值域上限 upper_inclusive Boolean 是否包含值域上限
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 smiles 是 String 分子SMILES表达式 custom_props 否 Array of CustomProp objects 用户已开启的自定义属性集合 表4 CustomProp 参数 是否必选 参数类型 描述 id 是 String 自定义属性的ID(API侧) 最小长度:1 最大长度:64 prop_definition 否 PropDefinition object 属性定义的元信息 表5 PropDefinition 参数 是否必选 参数类型 描述 id 否 String 属性业务侧ID 最小长度:1 最大长度:128 name 否 String 属性名称 最小长度:1 最大长度:32 type 否 String 属性类型 枚举值: binary numerical description 否 String 属性具体描述信息 最小长度:0 最大长度:256 value_range 否 ValueRange object 属性有效值域区间 optimal_range 否 ValueRange object 属性最优值域区间 warning_range 否 ValueRange object 属性欠佳值域区间 style 否 String 模型参数呈现类型 枚举值: number probability confidential_interval 否 Boolean 模型推理是否呈现置信区间 表6 ValueRange 参数 是否必选 参数类型 描述 lower 否 Number 值域下限 lower_inclusive 否 Boolean 是否包含值域下限 upper 否 Number 值域上限 upper_inclusive 否 Boolean 是否包含值域上限
  • 状态码 表1 状态码 状态码 编码 说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTPS的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204 No Content 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 207 Multi status 批量操作部分成功部分失败 300 Multiple Choices 多种选择。请求的资源可包括多个位置,可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址,使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。 414 Request URI Too Long 请求的URI过长(URI通常为网址),服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested Range Not Satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 Unprocessable Entity 请求格式正确,但是由于含有语义错误,无法响应。 429 Too Many Requests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 Internal Server Error 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 Gateway Timeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。 505 HTTP Version Not Supported 服务器不支持请求的HTTPS协议的版本,无法完成处理。 父主题: 附录
  • 响应参数 状态码: 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" : 2, "projects" : [ { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fd1", "name" : "demo-project-1", "creator" : "demo-user", "role" : "Admin", "size" : 1123243536, "status" : "ACTIVE", "tags" : [ "tag1" ], "description" : "This is demo project 1", "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z" }, { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fd2", "name" : "demo-project-2", "creator" : "demo-user", "role" : "Admin", "size" : 1123243536, "status" : "TO_BE_DELETED", "tags" : [ "tag1" ], "description" : "This is demo project 2", "create_time" : "2020-09-10T10:07:17Z", "update_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 X-Delete-Now 否 Boolean 非核心项目删除立即删除标记 缺省值:false
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 项目描述。 最小长度:0 最大长度:1024 status 否 String 项目状态。 枚举值: ACTIVE INACTIVE tags 否 Array of strings 项目标签。支持添加0~5个标签。 最小长度:1 最大长度:32 is_core 否 Boolean 是否为核心项目标记。 storage_quota 否 Long 项目数据容量配额。-1表示无容量限制。 取值范围:1073741824-11258999068426240。 单位:字节。
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求示例 更新项目,修改项目描述、标签,将项目更新为可用状态 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}{ "description" : "this is a demo project", "status" : "ACTIVE", "tags" : [ "tag" ]}
  • URI DELETE /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 user_id 是 String 被移除项目的用户id 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 role 是 String 项目角色。枚举值:Administrator、Developer、Uploader、Viewer 枚举值: Administrator Developer Uploader Viewer
  • URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/members/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 user_id 是 String 更新或者添加项目成员角色的用户id 最小长度:1 最大长度:128
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/transfer 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id 是 String 转移用户id 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 X-Bucket-Name 否 String X-Bucket-Name 最小长度:1 最大长度:128 X-Namespace-Name 否 String X-Namespace 最小长度:1 最大长度:128
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 医疗智能体平台项目ID,您可以在EIHealth平台单击所需的项目名称,进入项目设置页面查看“项目编号”。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。
  • 响应示例 状态码: 200 OK { "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "name" : "demo-project", "obs_bucket_name" : "eihealth-demo-project-sjdj3", "swr_namespace" : "eihealth-demo-project-sjdj3", "tags" : [ "tag1" ], "description" : "This is demo project", "creator" : "demo-user", "role" : "Admin", "roles" : [ { "role_type" : "Admin", "users" : [ { "id" : "adb1376b-72f9-4d15-9f95-9b533cb96dce", "name" : "demo-user" } ] } ], "size" : 1123243535, "status" : "TO_BE_DELETED", "update_time" : "2020-09-10T10:07:17Z", "create_time" : "2020-09-10T10:07:17Z", "delete_time" : "2020-09-10T10:07:17Z" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 项目id name String 项目名称 obs_bucket_name String 项目桶名 swr_namespace String 项目组织名 creator String 项目所有者 role String 当前用户在该项目上的角色 roles Array of ProjectRoleRsp objects 项目角色列表 size Long 项目桶存储量 status String 项目状态 tags Array of strings 标签列表 description String 项目描述 create_time String 项目创建时间 update_time String 项目更新时间 delete_time String 请求删除时间 is_core Boolean 核心项目标记 storage_quota Long 项目数据容量配额,-1表示无容量限制 表4 ProjectRoleRsp 参数 参数类型 描述 role_type String 项目角色类型 users Array of BindUserRsp objects 项目成员列表 表5 BindUserRsp 参数 参数类型 描述 id String 项目成员用户id name String 项目成员用户名
  • URI POST /v1/{project_id}/system/computing-resources/{id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 id 是 String 计算资源id 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制关闭,默认为false 缺省值:false
共100000条