华为云用户手册

URI GET /v1/{domain_id}/zones 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String path中租户的账号ID 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页的数量 最小值：1 最大值：2000 缺省值：2000 marker 否 String 分页标识 sort_key 否 Array 排序字段 sort_dir 否 Array 排序方式，取值范围： desc：降序 asc：升序

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 zones Array of ZoneDetail objects 地区列表 page_info PageInfo object 分页信息 表5 ZoneDetail 参数 参数类型 描述 code String 地区编码，如CN。不区分大小写，统一转为大写处理 name String 地区名称 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页标识。 current_count Integer 当前页数量。

示例流程 图1 给用户授权服务权限流程 创建用户组并授权 在 IAM 控制台创建用户组，并授予CFW只读权限“CFW ReadOnlyAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，验证权限： 在“服务列表”中选择 云防火墙 ，进入CFW主界面，单击“购买云防火墙”，尝试购买云防火墙，如果无法购买云防火墙（假设当前权限仅包含CFW FullAccess），表示“CFW FullAccess”已生效。 在“服务列表”中选择除CFW外（假设当前策略仅包含“CFW FullAccess”）的任一服务，若提示权限不足，表示“CFW FullAccess”已生效。

前提条件 给用户组授权之前，请您了解用户组可以添加的CFW权限，并结合实际需求进行选择，CFW支持的系统权限如表1所示。若您需要对除CFW之外的其它服务授权，IAM支持服务的所有权限请参见系统权限。 表1 CFW系统角色 角色名称 描述 类别 依赖关系 CFW FullAccess 云防火墙服务的所有权限。 系统策略 无 CFW ReadOnlyAccess 云防火墙服务的只读权限。 系统策略 无

匹配策略 应用域名组：CFW会将会话中的HOST字段与应用型域名进行比对，如果一致，则命中对应的防护规则。 网络域名组：CFW会在后台获取DNS服务器解析出的IP地址（每15s获取一次），当会话的四元组与网络型域名相关规则匹配、且本次访问解析到的地址在此前保存的结果中（已从DNS服务器解析中获取到IP地址），则命中对应的防护规则。 单个域名最大支持解析1000条IP地址；每个域名组最大支持解析1500条IP地址。解析结果达到上限，则无法再将新域名添加到域名组中 映射地址量大或映射结果变化快的域名建议优先使用应用域名组（如被内容分发网络（CDN）加速的域名）。

约束条件 基础版仅支持应用型域名组。 域名组成员不支持添加中文域名格式。 域名组中所有域名被“防护规则”引用最多40000次，泛域名被“防护规则”引用最多2000次。 应用域名组（七层协议解析） 每个域名组中最多添加1500个域名成员。 每个防火墙实例下最多添加500个域名组。 每个防火墙实例下最多添加2500个域名成员。 网络域名组（四层协议解析） 每个域名组中最多添加15个域名成员。 每个域名最大支持解析1000条IP地址。 每个域名组最大支持解析1500条IP地址。 每个防火墙实例下最多添加1000个域名成员。

版本信息说明 云防火墙提供了“基础版”、“标准版”、“专业版”供您使用，包括访问控制、入侵防御、流量分析以及日志审计等功能。 表1 版本差异说明 功能 基础版 标准版 专业版 防护规格 防护互联网边界公网IP数 20个（不可扩容） 20个（可扩容） 50个（可扩容） 防护互联网边界的流量峰值 10Mbps（不可扩容） 10Mbps（可扩容） 50Mbps（可扩容） 防护的VPC数量 × × 2个（可扩容） 防护的VPC间最大流量峰值 × × 200Mbps（随VPC数量扩容） 访问流量控制 公网资产ACL访问控制（基于IP、域名、域名组、地理位置等） √（仅支持通过Host或SNI字段匹配策略） √ √ 南北向流量防护，统一隔离防护云上资产在互联网的暴露风险（含EIP、E CS 公网IP等） √ √ √ 南北向流量审计，日志查询 √（仅支持访问控制日志和流量日志） √ √ 东西向流量防护，VPC间的资产保护、全流量分析 × × √ 东西向流量监控，实时获取VPC间流量数据 × × √ 防护策略 入侵防御IPS × √ √ 自定义IPS特征库 × × √ 虚拟补丁 × √ √ 敏感目录、反弹Shell × √ √ 病毒防御AV × × √

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限， 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 FormData参数 参数 是否必选 参数类型 描述 name 是 String 作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-) 最小长度：1 最大长度：63 description 否 String 作业的描述,取值范围：输入字符最大长度为255 最小长度：0 最大长度：255 labels 否 Array of strings 作业标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 workflow_id 是 String 作业依赖的流程id 最小长度：0 最大长度：135 params 否 File 流程参数列表文件，取值范围[0, 10M] priority 否 Integer 作业的优先级,取值范围[0,9]，0最低，默认数值0 最小值：0 最大值：9 缺省值：0

URI POST /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

请求示例 创建Nextflow作业，作业名为demo-job，指定id为caadcb56-5bb6-11eb-8a0d-fa163e3ddba1的流程 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs { "name" : "demo-job", "description" : "description", "labels" : "labelA,labelB", "workflow_id" : "caadcb56-5bb6-11eb-8a0d-fa163e3ddba1" }

响应示例 状态码： 200 OK { "count" : 1, "templates" : [ { "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", "name" : "demo-template", "description" : "description", "source_project_name" : "source project", "source_project_id" : "86e0f1b0-ac10-46a5-8fa7-b26831d7d488", "source_template_id" : "66e0f1b0-ac10-46a5-8fa7-b26831d7d488", "creator" : "demo-user", "columns" : [ { "name" : "column1", "type" : "Long", "description" : "description", "nullable" : false, "primary" : true, "searchable" : true, "unique" : true, "tips" : "tips" } ], "create_time" : "2021-01-29T09:10:27Z", "primary_key" : "ID,GROUP", "is_prefab" : false } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 模板总数 templates Array of TemplateRsp objects 模板列表 表4 TemplateRsp 参数 参数类型 描述 id String 模板id name String 模板名称 description String 模板描述 source_project_name String 来源项目名称 source_project_id String 来源项目id source_template_id String 来源模板id creator String 创建者 columns Array of DatabaseColumnDto objects 数据库列信息列表 create_time String 创建时间 primary_key String 主键 is_prefab Boolean 是否是预置模板 表5 DatabaseColumnDto 参数 参数类型 描述 name String 列名 最小长度：1 最大长度：55 type String 列类型 枚举值： Long String Double description String 列描述信息 最小长度：0 最大长度：1024 nullable Boolean 列是否允许为空 primary Boolean 是否作为主键 searchable Boolean 是否可查询 unique Boolean 是否唯一 tips String 查询参数格式的提示信息 最小长度：0 最大长度：1024

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 idle_time Integer 空置时间 threshold Integer 缩容阈值 delay_after_add Integer 扩容后多久再次判断缩容 delay_after_delete Integer 节点删除后多久再次判断缩容 delay_after_failure Integer 缩容失败后多久再次判断缩容 max_nodes_batch_deletion Integer 缩容并发数 check_interval Integer 检查间隔

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

响应示例 状态码： 200 OK { "count" : 1, "tags" : [ { "tag" : "v1.0", "size" : 269325517, "create_time" : "2020-12-28T09:36:41Z", "update_time" : "2020-12-28T09:36:41Z", "path" : "swr.cn-north-7.myhuaweicloud.com/namespace/image-name" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 镜像版本总数 tags Array of GetTagDetailRsp objects 镜像版本详情列表 表4 GetTagDetailRsp 参数 参数类型 描述 tag String 镜像版本名称 size Long 镜像版本大小 create_time String 镜像版本创建时间 update_time String 镜像版本更新时间 path String 镜像地址

响应示例 状态码： 201 CREATED 创建自由能微扰作业成功。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1" } 创建自由能微扰作业成功，当前运行作业数已达配额限制，此作业会等待。 { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "limit_concurrency" : 50 }

请求示例 创建自由能微扰作业，作业名称为demo-job，受体文件为project:/dir/file，配体分别为GLY:A:514和UNK1，路径图的中心配体为GLY:A:514，配体对分别为GLY:A:514和DrugBank:UNK1，预平衡步数为5000，平衡步数为50000，时间步长为0.002，lambda的个数为20。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "receptor" : { "source" : "PRIVATE", "url" : "project:/dir/file" }, "ligands" : [ { "name" : "GLY:A:514", "smiles" : "C1CCCCC1", "index" : 0, "file" : { "source" : "RAW", "format" : "PDB", "data" : "MODEL1.xxxxxxx.END" } }, { "name" : "UNK1", "smiles" : "c1ccccc1", "index" : 0, "file" : { "source" : "PRIVATE", "url" : "project:/dir/file" } } ], "graph" : { "center_id" : "GLY:A:514", "pairs" : [ { "ligand_ids" : [ "GLY:A:514", "DrugBank:UNK1" ] } ] }, "params" : { "num_pre_equilibrium_steps" : 50000, "num_equilibrium_steps" : 500000, "timestep_size" : 0.002, "num_lambda" : 20 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 receptor 是 ReceptorDrugFile object 受体文件。 ligands 是 Array of LigandPreviewDto objects 配体列表。 数组长度：2 - 101 graph 是 FepGraphDto object 路径图。 params 是 FepParamDto object FEP设置参数。 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度：5 最大长度：64 labels 否 Array of strings 标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 表5 ReceptorDrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，仅支持PDB，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 表6 LigandPreviewDto 参数 是否必选 参数类型 描述 index 是 Integer 配体索引（从0起编号）。 最小值：0 最大值：99 file 是 DrugFile object 配体文件。 name 是 String 配体名称，若无名称则自动命名，格式为UNK+索引（从1起编号）。 最小长度：1 最大长度：32 smiles 是 String 分子SMILES表达式。 最小长度：1 最大长度：512 表7 DrugFile 参数 是否必选 参数类型 描述 source 是 String 受体的数据源：外部网络数据（如RCSB在线数据库）、用户私有数据中心、承载租户公共数据（含样例/公共库）。 枚举值： EXTRANET PRIVATE PUBLIC RAW url 否 String 文件URL，当数据源为外部网络数据时为https地址；用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度：1 最大长度：2000 format 否 String 文件格式，支持PDB、SDF、MOL2、SMI，仅数据源为RAW时提供。 最小长度：1 最大长度：6 data 否 String 文件原始数据，仅数据源为RAW时提供。 最小长度：0 最大长度：10000000 表8 FepGraphDto 参数 是否必选 参数类型 描述 center_id 是 String 中心配体名称。 最小长度：1 最大长度：32 pairs 是 Array of SimilarityDto objects 配体对列表。 数组长度：1 - 100 表9 SimilarityDto 参数 是否必选 参数类型 描述 ligand_ids 是 Array of strings 配体对。 最小长度：1 最大长度：32 数组长度：2 - 2 表10 FepParamDto 参数 是否必选 参数类型 描述 pre_equilibrium_time 否 Float 预平衡时长，单位ps，范围为0-200，不包含0，默认为100ps。 最小值：0 最大值：200.0 equilibrium_time 否 Float 平衡时长，单位ns，范围为0-10，不包含0，默认为1ns。 最小值：0 最大值：10.0 num_pre_equilibrium_steps 否 Integer 预平衡步数，默认为50000。 最小值：1 最大值：200000 num_equilibrium_steps 否 Integer 平衡步数，默认为500000。 最小值：1 最大值：10000000 timestep_size 否 Float 时间步长，单位ps，取值范围：大于0，小于等于0.005。 最小值：0.001 最大值：0.005 缺省值：0.002 num_lambda 否 Integer lambda个数。 最小值：2 最大值：30 缺省值：20

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/fep 表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。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 mode 是 String 创建配体相似度图的模式：中心模式、自由模式。 枚举值： CENTER FREE ligands 是 Array of CreateLigandSimilarityGraphLigandDto objects 配体列表。 数组长度：2 - 101 表4 CreateLigandSimilarityGraphLigandDto 参数 是否必选 参数类型 描述 name 是 String 配体分子唯一名字，受体中的建议使用"{氨基酸}:{链}:{编号}"。 最小长度：1 最大长度：32 smiles 是 String 分子SMILES表达式。 最小长度：1 最大长度：512 main 否 Boolean 配体是否为主要配体，在中心模式下，必须指定1个主要配体。 缺省值：false

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/similarity-graph 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 eihealth_project_id 是 String 平台项目ID。 最小长度：1 最大长度：128

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

URI PUT /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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 summary 否 String 短描述 最小长度：0 最大长度：128 description 否 String 长描述 最小长度：0 最大长度：65535 picture 否 String 封面图片base64编码 最小长度：0 最大长度：50000 labels 否 Array of strings 标签列表 最小长度：1 最大长度：32 数组长度：0 - 5

请求示例 修改资产信息，更新短描述、长描述、封面图、标签 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/assets/{asset_id}/versions/{version} { "summary" : "this is summary", "description" : "this is description", "picture" : "data:image/png;base64,xxxxx", "labels" : [ "label1" ] }

响应示例 状态码： 200 OK { "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", "workflow_file" : "workflow.zip", "workflow_file_url" : "https://workflow.zip", "main_file" : "main.nf", "params_file" : "p1.yaml", "source_project_name" : "src", "source_resource_id" : "src-id", "params" : [ { "name" : "p1", "value" : "hello", "type" : "Other", "description" : "desc", "required" : true } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 流程id name String 流程名称 description String 流程描述 labels Array of strings 流程标签 workflow_file String 流程的文件名 workflow_file_url String 流程的文件名下载地址 main_file String 主文件名 params_file String 用户上传时使用的参数文件名 params Array of NextflowParamsDto objects 流程参数列表 create_time String 流程的创建时间 update_time String 流程的更新时间 source_project_name String 源项目名称 source_resource_id String 源资源id 表4 NextflowParamsDto 参数 参数类型 描述 name String 参数名 最小长度：1 最大长度：1024 value String 参数值 最小长度：0 最大长度：65535 type String 参数类型,取值[Other|File|Directory] 最小长度：0 最大长度：20 description String 参数描述。取值范围：[0-255] 最小长度：0 最大长度：255 required Boolean 参数是否必填

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