华为云用户手册

  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows/{workflow_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 workflow_id 是 String 流程id 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称 最小长度:3 最大长度:32 template_id 是 String 模板id 最小长度:1 最大长度:128 description 否 String 实例描述 最小长度:0 最大长度:1024 import_data 否 ImportDatabaseDataReq object 导入数据请求体 表4 ImportDatabaseDataReq 参数 是否必选 参数类型 描述 files 是 Array of strings 导入文件l路径列表 最小长度:1 最大长度:1024 数组长度:1 - 5 delimiter 是 String 分隔符,常见分隔符为, ; 最小长度:1 最大长度:32 skip_lines 是 Integer 跳过的header行数 最小值:0 最大值:1000
  • 请求示例 创建数据库实例,名称为demo-instance,模板ID为56e0f1b0-ac10-46a5-8fa7-b26831d7d488,导入test-project-01项目中db_test1.txt文件的数据,分隔符为string https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases { "name" : "demo-instance", "template_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "description" : "description", "import_data" : { "files" : [ "test-project-01:/db_test1.txt" ], "delimiter" : "string", "skip_lines" : 0 } }
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/databases 表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参数 参数 是否必选 参数类型 描述 description 否 String 项目描述 最小长度:0 最大长度:1024 status 否 String 项目状态。枚举值:ACTIVE、INACTIVE 枚举值: ACTIVE INACTIVE tags 否 Array of strings 项目标签 最小长度:1 最大长度:32 数组长度:0 - 5 is_core 否 Boolean 是否为核心项目标记 storage_quota 否 Long 项目数据容量配额,单位为字节,范围为1073741824-11258999068426240,-1表示无容量限制 最小值:-1 最大值:11258999068426240
  • 请求示例 更新项目,修改项目描述、标签,将项目更新为可用状态 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 PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id} 表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。 表3 请求Body参数 参数 是否必选 参数类型 描述 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 five_minutes fifteen_to_twenty_minutes one_hour method 否 String 统计方法。枚举值,取值范围:max(最大值)、min(最小值)、average(平均值),不填时默认为max 枚举值: max min average resource_ids 是 Array of strings 查询的监控资源对象id集合 最小长度:1 最大长度:128 数组长度:1 - 50
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 metric_statistics Array of ResourceStatDataRsp objects 资源统计数据列表 表5 ResourceStatDataRsp 参数 参数类型 描述 statistic String 统计值 unit String 数据单位 metric_name String 监控指标名称 resource_id String 监控资源id device_id String 显卡id
  • 请求示例 批量下载监控数据,设置起止时间,实时数据,统计方式为max, 指定资源id列表 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/metric-data/batch-stat-metric-data { "from_time" : 1234567891011, "to_time" : 1234567891012, "period" : "real_time", "method" : "max", "resource_ids" : [ 123456789 ] }
  • 响应示例 状态码: 200 OK { "metric_statistics" : [ { "statistic" : "12345", "unit" : "bytes/second", "metric_name" : "read_bandwidth", "resource_id" : "123456789", "device_id" : "123456789" } ] }
  • 响应示例 状态码: 200 OK { "count" : 1, "studies" : [ { "name" : "demo-study", "id" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169", "eihealth_project_name" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169", "eihealth_project_id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda", "description" : "this is a demo study", "create_time" : "2021-02-22T07:06:21Z", "update_time" : "2021-02-22T07:06:21Z", "latest_job" : { "id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "workflow_job_id" : "78dfce53-0303-4b46-a2d9-4a067812b289", "name" : "study-job", "status" : "RUNNING", "template_id" : "24dfce53-0303-4b46-a2d9-4a067812b289", "database_name" : "demo-database", "database_id" : "4f7fce53-0303-4b46-a2d9-4a067812b289", "relative_path" : "/docking-summary", "output_file_type" : "csv", "workflow_name" : "docking-summary", "label" : "small-molecular-chemicals", "create_time" : "2021-02-22T07:07:41Z", "update_time" : "2021-02-22T07:07:41Z" } } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer study总数 studies Array of StudyRsp objects study列表 表4 StudyRsp 参数 参数类型 描述 name String study名称 id String study id eihealth_project_name String 项目名称 eihealth_project_id String 项目id description String study描述 create_time String study创建时间 update_time String study更新时间 latest_job StudyJobRsp object 作业详情返回体 表5 StudyJobRsp 参数 参数类型 描述 id String study作业id workflow_job_id String workflow作业id name String 作业名称 status String 作业状态 template_id String 生成study作业结果的模板id database_name String study作业结果的数据库实例名称 database_id String study作业结果的数据库实例id relative_path String 生成study作业结果的文件的相对路径 output_file_type String 生成study作业结果的文件的类型 workflow_name String 使用的workflow名称 label String 使用的workflow标签 create_time String 作业创建时间 update_time String 作业更新时间
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 operation String 是否开启资源配额限制 枚举值: OPEN CLOSE settings UserSettingDto object 更新用户请求体 表4 UserSettingDto 参数 参数类型 描述 job_quota Integer 允许同时运行的作业数 最小值:1 最大值:100 job_timeout Integer 作业执行超时时长,单位天 最小值:1 最大值:60 cpu_quota Integer 作业的CPU资源配额,单位核 最小值:1 最大值:1024 mem_quota Integer 作业的内存资源配额,单位GB 最小值:1 最大值:1024 projects_per_user Integer 用户可创建项目数配额 最小值:0 最大值:20 缺省值:2
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs/{auto_job_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 auto_job_id 是 String 自动作业id 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
  • 响应示例 状态码: 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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 规格编码 最小长度:1 最大长度:128 disk_space 否 Integer 磁盘存储空间,该字段暂不生效 最小值:40 最大值:1000 disk_encrypt 是 Boolean 磁盘是否加密
  • 响应示例 状态码: 200 OK { "count" : 1, "logs" : [ "Nextflow 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" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 请求示例 更新缩容策略,设置空闲时间为2分钟,扩容后多久再次判断缩容时间为5分钟 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/system/autoscaler/scale-in-policy { "idle_time" : 2, "threshold" : 50, "delay_after_add" : 5, "delay_after_delete" : 1, "delay_after_failure" : 1, "max_nodes_batch_deletion" : 1, "check_interval" : 1 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 idle_time 否 Integer 空置时间 最小值:1 最大值:10080 threshold 否 Integer 缩容阈值 最小值:1 最大值:100 delay_after_add 否 Integer 扩容后多久再次判断缩容 最小值:5 最大值:10080 delay_after_delete 否 Integer 节点删除后多久再次判断缩容 最小值:1 最大值:10080 delay_after_failure 否 Integer 缩容失败后多久再次判断缩容 最小值:1 最大值:10080 max_nodes_batch_deletion 否 Integer 缩容并发数 最小值:1 最大值:50 check_interval 否 Integer 检查间隔 最小值:1 最大值:10080
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 批量删除标签id列表 最小长度:1 最大长度:128 数组长度:1 - 50
  • 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
  • URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/terminate 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_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。 表3 请求Body参数 参数 是否必选 参数类型 描述 force 是 Boolean 是否强制终止,默认为false 缺省值:false
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 path String 对象全路径(项目名称:/路径) name String 名称 type String 枚举值: FILE FOLDER size Long 大小 缺省值:0 create_time String 创建时间 content String 文件内容 download_url String 下载链接 allowed_operate Boolean 可操作标记 缺省值:true deletable Boolean 可删除标记 缺省值:true
  • 响应示例 状态码: 200 OK { "path" : "test-project-id:/test.txt", "name" : "db_test1.txt", "type" : "FILE", "size" : 1024, "create_time" : "2021-02-01T14:25:34Z", "download_url" : "https://www.hhh.com/db_test1.txt", "allowed_operate" : true }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas/{path} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 path 是 String 对象全路径(项目名称:|路径) 最小长度:1 最大长度:2000 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128
共100000条