华为云用户手册

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

约束与限制 使用MRS前，您需要认真阅读并了解以下使用限制。 MRS集群必须创建在VPC子网内。 建议使用推荐的浏览器登录MRS。 Google Chrome：36.0及更高版本 Internet Explorer：9.0及更高版本 使用Internet Explorer 9.0时可能无法登录MRS管理控制台，原因是某些操作系统默认禁止了Administrator用户，浏览器在安装时自动选择其他用户如System用户安装，从而导致无法打开登录页面。请使用管理员身份重新安装浏览器或更高版本（建议），或尝试使用管理员身份运行浏览器。 Microsoft Edge：随Windows操作系统更新。 创建MRS集群时，支持自动创建安全组，也可选择已有的安全组。集群创建完成后，请勿随意删除或更改已使用的安全组。否则可能导致集群异常，影响MRS集群的正常使用。 MRS集群使用的安全组请勿随意放开权限，避免被恶意访问。 请勿随意执行如下操作，避免集群进入异常状态，影响MRS集群的使用。 在ECS服务管理控制台对MRS集群的节点进行关机、重启、删除、变更OS、重装OS和修改规格等操作。 删除集群节点上已有的进程、安装的应用程序和文件。 删除MRS集群节点，集群节点丢失造成集群异常后依旧会收取费用，导致您的损失。 集群处于非人为异常状态时，可以联系技术支持人员，技术支持人员征得您同意后会请您提供密码，登录MRS集群进行问题排查。 MRS不会保存您设置的登录Master节点的初始密码，请您设置并保管好密码。为避免被恶意攻击，建议设置复杂度高的密码。 集群处于异常状态时，MRS仍然会收取集群费用。建议您及时联系技术支持人员处理集群异常。 请根据业务需要规划集群节点的磁盘，如果需要存储大量业务数据，请及时增加云硬盘数量或存储空间。以防止存储空间不足影响节点正常运行。 MRS集群节点仅用于存储用户业务数据，非业务数据建议保存在对象存储服务或其他弹性云服务器中。 MRS集群节点仅用于运行MRS集群内服务，其他客户端应用程序、用户业务程序建议申请独立弹性云服务器部署。 MRS集群扩容（包含存储能力和计算能力）可通过增加Core节点或者Task节点的方式实现。 当MRS集群中某一个Master节点关闭后，如果仍然使用集群执行作业任务或修改组件配置，在操作后必须先启动被关闭的Master节点，然后才能执行其他节点的关闭操作，否则会由于角色主备倒换导致数据丢失的风险。 若MRS集群中节点已经被全部关闭，请按照节点关机顺序的倒序启动集群节点。 当使用MRS集群过程中进行Capacity和Superior调度器切换时，系统只会完成调度器的切换，不保证队列配置同步。如果您需要配置同步，建议基于新的调度器重新配置。 MRS集群中Spark及其他引擎禁止执行自读自写的SQL语句。 例如： insert overwrite table test select * from test; insert overwrite table test select a.* from test a join test2 b on a.name=b.name;

HetuEngine结构 HetuEngine包含不同模块，整体结构如图1所示。 图1 HetuEngine结构图 表1 各模块说明 模块名称 常见概念名称 描述 云服务层 HetuEngine CLI/JDBC HetuEngine的客户端，使用者通过客户端向服务端提交查询请求，然后将执行结果取回并展示。 HSBroker HetuEngine的服务管理，用作计算实例的资源管理校验，健康监控与自动维护等。 HSConsole 对外提供数据源信息管理，计算实例管理，自动化任务的查看等功能的可视化操作界面和RESTful接口。 HSFabric 提供跨域（DC）高性能安全数据传输。 引擎层 Coordinator HetuEngine计算实例的管理节点，提供SQL接收、SQL解析、生成执行计划、执行计划优化、分派任务和资源调度等能力。 Worker HetuEngine计算实例的工作节点，提供数据源数据并行拉取，分布式SQL计算等能力。

防护流量 入云流量：从Internet流入云防火墙方向的流量，例如，从公网下载资源到云内服务器。 出云流量：从云防火墙流出到Internet方向的流量，例如，云内服务器对外提供服务，外部用户下载云内的资源。 防护带宽：所有经过云防火墙防护的业务带宽。 互联网边界的流量峰值：所有经过云防火墙防护的EIP的流量总和最大值，按照入云流量（入流量）或出云流量（出流量）的最大值取值。 VPC边界的流量峰值：所有经过云防火墙防护的VPC的流量总和最大值。

修订记录 发布日期 修改说明 2024-04-29 第二十二次正式发布。 新增： 收到流量超限预警如何处理？章节。 2024-04-08 第二十一次正式发布。 新增： 资源部署在DEC（专属云）上是否支持使用云防火墙防护？章节。 2024-01-15 第二十次正式发布。 新增： 是否支持同时部署WAF、DDoS高防和CFW？章节。 业务流量异常如何排查CFW侧防护？章节。 流量趋势模块和流量分析页面展示的流量有什么区别？章节。 2023-12-20 第十九次正式发布。 新增NAT64防护策略配置需要注意哪些？章节。 2023-10-11 第十八次正式发布。 新增： 云防火墙和安全组、网络ACL的访问控制有什么区别？章节。 IPS拦截了正常业务如何处理？章节。 2023-08-02 第十七次正式发布。 新增： VPC个数和VPC边界防护流量峰值如何计算？章节。 2023-07-05 第十六次正式发布。 新增： 云防火墙的防护顺序是什么？章节。 访问控制日志没有数据怎么办？章节。 优化云防火墙支持跨账号使用吗？章节，支持跨账号使用。 下线“华为旁路引擎”相关内容： “标准版旁路引擎服务停售相关问题”章节。 “华为旁路引擎（已下线）版本的访问控制日志中为什么看不见放行规则的记录”章节。 “购买华为旁路引擎（已下线），后面可以切换为直路引擎吗？” 2023-05-06 第十五次正式发布。 新增系统策略授权企业项目后，为什么部分权限会失效？章节。 2023-01-19 第十四次正式发布。 新增“标准版旁路引擎服务停售相关问题”章节。 新增API类章节。 2022-10-28 第十三次正式发布。 修改云防火墙提供的防护带宽是多少？防护带宽流量计算方式。 2022-09-27 第十二次正式发布。 新增“华为旁路引擎（已下线）版本的访问控制日志中为什么看不见放行规则的记录”章节。 新增配置了策略为什么没有生效？章节。 2022-07-25 第十一次正式发布。 新增云防火墙提供的防护带宽是多少？章节。 新增“计费类”及其子章节。 2022-07-21 第十次正式发布。 新增云防火墙是否支持跨云或跨区域使用？章节。 2022-04-09 第九次正式发布。 新增以下章节。 “购买华为旁路引擎（已下线），后面可以切换为直路引擎吗？” QPS高，流量峰值就高吗？ 云防火墙攻击日志，为什么显示还未纳入防护的EIP？ 4.4.9-Spring Framework远程代码执行漏洞攻击，华为云云防火墙如何启用检测和防御？ 2022-01-11 第八次正式发布。 新增业务流量超过防护带宽怎么办？章节。 2021-12-10 第七次正式发布。 新增4.4.8-Apache Log4j 远程代码执行漏洞攻击，华为云云防火墙如何启用检测和防御？章节。 2021-12-08 第六次正式发布。 新增云防火墙支持线下服务器吗？章节。 2021-10-25 第五次正式发布。 新增云防火墙支持哪些维度的访问控制？章节。 2021-10-12 第四次正式发布。 新增以下章节： 云防火墙支持跨账号使用吗？ 云防火墙与Web应用防火墙有什么区别？ 通过日志功能可以查看哪些信息？ 2021-08-17 第三次正式发布。 新增云防火墙可以跨区域使用吗？章节。 2021-07-29 第二次正式发布。 新增网络流量类章节。 修改功能类章节，优化章节内容。 2021-06-30 第一次正式发布。

请求示例 插入两条入方向规则到id为e9a7731d-5bd9-4250-a524-b9a076fd5629的网络ACL中，插入到规则a2a7731d-5bd9-4250-a524-b9a076fd5630之后。 PUT https://{Endpoint}/v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/insert-rules { "firewall" : { "ingress_rules" : [ { "name" : "network_acl_rule ipv4 test", "description" : "network_acl_rule ipv4 test", "action" : "allow", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null },{ "name" : "network_acl_rule ipv6 test", "description" : "network_acl_rule ipv6 test", "action" : "allow", "protocol" : "tcp", "ip_version" : "6", "source_ip_address" : "2002:50::44", "destination_ip_address" : "2002:51::44", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null } ], "insert_after_rule" : "a2a7731d-5bd9-4250-a524-b9a076fd5630" } } 插入两条出方向规则到id为e9a7731d-5bd9-4250-a524-b9a076fd5629的网络ACL中，插入到规则a3a7731d-5bd9-4250-a524-b9a076fd5630之后。 PUT https://{Endpoint}/v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/insert-rules { "firewall" : { "egress_rules" : [ { "name" : "network_acl_rule ipv4 test", "description" : "network_acl_rule ipv4 test", "action" : "allow", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null },{ "name" : "network_acl_rule ipv6 test", "description" : "network_acl_rule ipv6 test", "action" : "allow", "protocol" : "tcp", "ip_version" : "6", "source_ip_address" : "2002:50::44", "destination_ip_address" : "2002:51::44", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null }], "insert_after_rule" : "a3a7731d-5bd9-4250-a524-b9a076fd5630" } }

响应示例 状态码： 200 OK { "firewall" : { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_test1", "description" : "network_acl_test1", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "created_at" : "2022-04-07T07:30:46Z", "updated_at" : "2022-04-07T07:30:46Z", "admin_state_up" : true, "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9", "status" : "ACTIVE", "tags" : [ ], "ingress_rules" : [{ "id" : "a2a7731d-5bd9-4250-a524-b9a076fd5630", "name" : "network_acl_rule", "description" : "network_acl_rule", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.13.0/24", "destination_ip_address" : "192.168.16.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null },{ "id" : "4afc959f-5380-dd94-8082-5701f6bc3f1c", "name" : "network_acl_rule ipv4 test", "description" : "network_acl_rule ipv4 test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null },{ "id" : "b49dcd4c-508e-4b99-9093-2680616f2a7e", "name" : "network_acl_rule ipv6 test", "description" : "network_acl_rule ipv6 test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "6", "source_ip_address" : "2002:50::44", "destination_ip_address" : "2002:51::44", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null }], "egress_rules" : [{ "id" : "a3a7731d-5bd9-4250-a524-b9a076fd5630", "name" : "network_acl_rule", "description" : "network_acl_rule", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.13.0/24", "destination_ip_address" : "192.168.16.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null },{ "id" : "f9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_rule ipv4 test", "description" : "network_acl_rule ipv4 test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null }, { "id" : "bbbc1cd1-b8e1-45d3-b3bc-7bc360f8860d", "name" : "network_acl_rule ipv6 test", "description" : "network_acl_rule ipv6 test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "6", "source_ip_address" : "2002:50::44", "destination_ip_address" : "2002:51::44", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null }], "associations" : [ { "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143" } ] } }

请求示例 在id为e9a7731d-5bd9-4250-a524-b9a076fd5629的网络ACL中更新入方向规则e9a7731d-5bd9-4250-a524-b9a076fd5629 PUT https://{Endpoint}/v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/update-rules { "firewall" : { "ingress_rules" : [ { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_rule test2", "description" : "network_acl_rule test2", "action" : "allow", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null } ] } }

响应示例 状态码： 200 OK { "firewall" : { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_test1", "description" : "network_acl_test1", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "created_at" : "2022-04-07T07:30:46Z", "updated_at" : "2022-04-07T07:30:46Z", "admin_state_up" : true, "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9", "status" : "ACTIVE", "tags" : [ ], "ingress_rules" : [ { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_rule test2", "description" : "network_acl_rule test2", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null } ], "egress_rules" : [ { "id" : "f9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_rule test", "description" : "network_acl_rule test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null } ], "associations" : [ { "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143" } ] } }

修订记录 版本日期 变更说明 2024-5-9 第九次发布。 修改“消息接收配置”章节。 修改“语音接收配置”章节。 修改“接收人管理”章节 2024-04-26 第八次发布。 修改“消息接收配置”章节。 修改“语音接收配置”章节。 修改“接收人管理”章节。 2023-05-29 第七次发布。 修改“消息接收配置”章节。 修改“语音接收配置”章节。 修改“接收人管理”章节。 2022-01-24 第六次发布。 调整目录结构。 新增“权限管理”章节。 修改“消息接收管理”章节。 修改“消息接收配置”章节。 修改“接收人管理”章节。 2021-01-18 第五次发布。 调整目录结构。 新增“语音接收配置”章节。 修改“站内消息”章节。 修改“消息接收配置”章节。 修改“接收人管理”章节。 2019-07-08 第四次发布。 修改“消息类别介绍”中的消息类别、消息介绍。 修改“新增接收人”章节。 修改“订阅管理”章节。 2018-12-19 第三次发布。 “消息类别介绍”增加关于IAM子用户查看财务类消息的限制说明。 2018-10-30 第二次发布。 修改"消息接收管理"界面。 添加"接收人管理"界面。 2017-07-30 第一次正式发布。

请求示例 发布镜像，指定资产形成为demo-image，版本号为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/publish { "image_id" : "354d8f5c-aecf-43cc-8204-2e00a103ece1", "tag" : 1.0, "name" : "demo-image", "version" : "1.0.0", "picture" : "", "labels" : [ "label1", "label2" ], "summary" : "summary", "description" : "description" }

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

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

URI GET /v1/{project_id}/assets/properties 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 property 是 String 属性，支持LABEL/PUBLISHER/CATEGORY 最小长度：1 最大长度：128

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

请求示例 创建分子优化作业，作业名称为demo-job，分子SMILES表达式为string，靶点设置的受体文件为project:/test.pdb，口袋中心位置为[0,0,0]，口袋尺寸大小为[500,500,500]，设置强约束为cs1类型为布尔值，值为true，设置弱约束为cs2，类型为range，值为[0,1]。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-jobs/optimization { "basic_info" : { "name" : "demo-job", "labels" : [ "labelA" ] }, "smiles" : "string", "num_trials" : 500, "binding_sites" : [{ "name" : "target1", "receptor" : { "source" : "PRIVATE", "url" : "project:/test.pdb" }, "bounding_box" : { "center" : [ 0, 0, 0 ], "size" : [ 500, 500, 500 ] }, "remove_ion" : false, "remove_water" : false, "remove_ligand" : false }], "weak_constraints" : [ { "name" : "cs1", "type" : "bool", "bool" : true } ], "strong_constraints" : [ { "name" : "cs2", "type" : "range", "range" : [ 0, 1 ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 basic_info 是 CreateDrugJobBasicInfo object 创建药物作业基本信息。 smiles 否 String 分子SMILES表达式。 最小长度：1 最大长度：512 molecule_file 否 DrugFile object 分子文件。 binding_site 否 BindSiteDto object 受体。 binding_sites 否 Array of BindSiteDto objects 受体列表和受体是二选一的关系，受体列表优先级最高。 数组长度：0 - 2 weak_constraints 否 Array of WeakConstraintDto objects 弱约束集合。 数组长度：0 - 16 strong_constraints 否 Array of StrongConstraintDto objects 强约束集合。 数组长度：0 - 4 sampler_mixin_weight 否 Float 初始化采样权重，参数范围(0.5, 1)，不包含0.5和1，默认为0.6。 最小值：0.5 最大值：1 缺省值：0.6 model_ids 否 Array of strings 模型id列表。 最小长度：1 最大长度：128 数组长度：0 - 10 num_trials 否 Integer 生成分子数量。 最小值：0 最大值：5000 缺省值：5000 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 作业的名称，取值范围：[5,64]，允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 最小长度：5 最大长度：64 labels 否 Array of strings 标签，取值范围[0,5]，单个标签最大长度32字符，支持中文、字母、数字、空格、下划线和中划线，且不能以空格开头或者结尾。 最小长度：1 最大长度：32 数组长度：0 - 5 表5 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 表6 BindSiteDto 参数 是否必选 参数类型 描述 name 否 String 靶点名称，只能设置为target1或者target2。 最小长度：1 最大长度：128 receptor 是 ReceptorDrugFile object 受体文件。 bounding_box 否 BoundingBoxDto object 结合口袋，包含口袋中心位置和尺寸大小。 remove_ion 否 Boolean 去除受体中的离子。 缺省值：true remove_water 否 Boolean 去除受体中的水分子。 缺省值：true remove_ligand 否 Boolean 去除受体中的配体分子。 缺省值：true add_hydrogen 否 Boolean 增加氢原子。 缺省值：false 表7 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 表8 BoundingBoxDto 参数 是否必选 参数类型 描述 center 是 Array of floats 口袋中心坐标； x, y, z轴的坐标。 最小值：-9999999 最大值：99999999 数组长度：3 - 3 size 是 Array of floats 口袋尺寸大小； x, y, z轴的大小。 最小值：2 最大值：500 数组长度：3 - 3 padding 否 Float 填充。 最小值：0 最大值：20 表9 WeakConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型id，仅弱约束为模型时填写。 最小长度：1 最大长度：128 name 否 String 属性名称。 最小长度：1 最大长度：128 type 是 String 属性约束类型。 枚举值： bool range struct minimize maximize bool 否 Boolean 属性约束类型bool的参数。 range 否 Array of floats 属性约束类型range的参数。 最小值：-9999 最大值：9999 数组长度：2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数。 quantiles 否 Array of floats 属性约束类型minimize和maximize的参数。 最小值：0.0 最大值：1.0 数组长度：2 - 2 表10 StrongConstraintDto 参数 是否必选 参数类型 描述 id 否 String 自定义模型id，仅强约束为模型时填写。 最小长度：1 最大长度：128 name 否 String 属性名称。 最小长度：1 最大长度：128 type 是 String 属性约束类型。 枚举值： bool range struct bool 否 Boolean 属性约束类型bool的参数。 range 否 Array of floats 属性约束类型range的参数。 最小值：-9999 最大值：9999 数组长度：2 - 2 struct 否 StructureConstraintParamsDto object 结构约束参数。 表11 StructureConstraintParamsDto 参数 是否必选 参数类型 描述 structs 是 Array of strings 子结构SMILES。 最小长度：1 最大长度：120 数组长度：1 - 8 exclusive 是 Boolean 是否排除子结构。 operator 否 String 多个子结构之间的逻辑关系。 枚举值： or and

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

URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas 表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参数 参数 是否必选 参数类型 描述 name 是 String 文件夹名称 最小长度：1 最大长度：2000 parent_folder 否 String 所在文件夹 最小长度：0 最大长度：2000

响应示例 状态码： 200 OK { "id" : "aa78f595-5acb-4be8-b277-229be335633a", "category" : "WORKFLOW", "name" : "Docking Summary", "title" : "Docking Summary", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "https://eihealth.obs.cn-north-4.huawei.com:443/assets/metadata/picture.png", "vendor_id" : "00000000000000000000000000000000", "versions" : [ { "version" : "1.0.0", "publisher" : "EIHealth", "description" : "", "summary" : "summary", "license" : "", "status" : "NORMAL", "failed_reason" : "internal error", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "https://eihealth.obs.cn-north-4.huawei.com:443/assets/metadata/picture.png", "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z" } ], "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z", "stars" : 0, "subscribes" : 1 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 资产id category String 类别 name String 资产名 title String 资产展示名 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 vendor_id String 供应商id versions Array of VersionRsp objects 资产版本号列表 create_time String 创建时间 update_time String 更新时间 stars Integer 收藏数 subscribes Integer 订阅数 表4 VersionRsp 参数 参数类型 描述 version String 资产版本号 publisher String 发布者 description String 资产长描述 summary String 资产短描述 license String 许可证 status String 资产状态 failed_reason String 资产发布失败原因 labels Array of strings 资产标签列表 picture String 资产封面图访问链接 create_time String 创建时间 update_time String 更新时间

响应示例 状态码： 200 OK { "report_files" : [ { "name" : "DAG.png", "download_url" : "https://nextflow-cn-north-7-07d79450.obs.cn-north-7.ulanqab.huawei.com/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }, { "name" : "report.html", "download_url" : "https://nextflow-cn-north-7-07d79450.obs.cn-north-7.ulanqab.huawei.com/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/report.html?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 report_files Array of NextflowJobReportFile objects 作业报告文件列表 表4 NextflowJobReportFile 参数 参数类型 描述 name String 报告文件名 最小长度：1 最大长度：1024 download_url String 报告文件下载地址 最小长度：1 最大长度：1024

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

响应示例 状态码： 200 OK { "count" : 1, "backups" : [ { "id" : "0e228eb7-df7f-49fb-844e-84bb8df9a71a", "name" : "归档2021", "type" : "manul", "storage_type" : "STANDARD", "region" : "same", "paths" : [ "project-name:/folder1/", "project-name:/file1" ], "start_time" : "2021-02-01T14:25:34Z", "end_time" : "2021-02-01T14:25:50Z", "size" : 1024, "description" : "归档描述", "operator_name" : "测试人员01" } ] }

URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/backups 表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和asc，默认为desc） 缺省值：desc sort_key 否 String 排序字段（支持type, end_time）

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 归档记录总数量 backups Array of BackupDto objects 归档记录列表 表5 BackupDto 参数 参数类型 描述 id String id name String 归档名称 type String 类型 storage_type String 存储类型 region String 区域 paths Array of strings 归档数据路径集 start_time String 归档开始时间 end_time String 归档结束时间 archive_days Integer 已归档天数 size Long 大小 description String 归档描述 operator_name String 归档人员姓名