华为云用户手册

  • 监控、安全、成本等模块概览信息 表2 模块概述和使用 模块 概述 如何使用 云监控 显示资源的监控信息,包括告警级别及各级比告警总次数。 单击“”,跳转至告警记录,可查看所有告警记录。 安全监控 实时监控最新威胁告警事件、最新漏洞风险事件和最新基线。 单击“”,跳转至安全看板,进行事件的查看和处理。 单击“升级”,可将基础版 安全云脑 升级到更高版本,以获取更全面的安全监控体验。 单击“应急漏洞”,跳转至漏洞管理,可查看历史漏洞信息。 成本概览 显示当月成本和月末预测成本,与上月成本的环比情况,以及当月不同产品类型的成本分布。 单击“”进入成本中心,进行成本的查看和管理。 费用概况 显示客户账户费用信息,包括:可用额度、现金余额、可开票金额、卡券信息。 单击“费用概况”右侧的“”,跳转至费用中心,可查看更多费用相关信息。 单击“充值”、“提现”、“汇款认领”“去开票”,进行相应操作。 单击“代金券”右侧的“”,查看卡券详情。 学习天地 显示云服务相关帮助文档及学习资源,包括华为云入门在线课程、新手入门、KooLabs云实验、最佳实践、视频教程。 帮助中心:帮助中心首页入口。 华为云入门:报名参加在线课程。 新手入门:了解云服务基础。 KooLabs云实验:了解开发者云实验。 最佳实践:学习云服务使用最佳实践。 视频教程:学习云服务相关视频教程。 开发者工具 显示支持的开发者工具,包括 API Explorer 、Huawei Cloud Toolkit等。 单击“”,跳转至华为云开发者官网,可查看更多开发者相关信息。 单击具体的工具,可跳转至对应操作页面。 公告 展示最新的3个华为云动态。 单击“”,可查看历史公告。 华为云APP下载 显示运营广告内容,提供华为云APP下载方式,使用华为云APP,可随时随地,管控资源。 -
  • 总览 按云服务维度、以卡片形式展示您当前所拥有的全局资源的名称、数量,并支持按区域名、服务名以及资源名进行搜索。 图3 总览页签 当您使用 IAM 用户登录管理控制台时,可能因权限不足,无法查看资源或对资源进行操作。这时,您需要对IAM用户进行授权。详细操作,请参见控制台首页找不到资源怎么办?。 部分资源可能会由于未接入控制台,而无法在此模块中展示。 单击“已支持的服务和区域”,查看当前已接入控制台的服务以及支持的区域。 单击“我的资源”,查看资源的更多信息。 在“总览”页签,您可以进行如下操作: 在搜索框中,可通过区域名、服务名以及资源名进行搜索,便于快速定位资源。 仅支持搜索已购买或已创建资源。 单击云服务卡片,可跳转至云服务控制台。 单击云服务卡片中的资源数量,可显示资源清单侧滑面板,该面板包含资源在不同区域的数量信息,以及资源的名称、区域、创建时间的列表信息。 单击资源列表中的资源名称,可跳转至对应资源基本信息页面。 图4 资源数量及区域 通过拖动服务卡片或卡片右上角的“”,可以调整服务卡片的位置。 图5 调整卡片位置
  • 头部名片区 展示用户账号信息和账户费用信息,提供创建资源便捷入口以及我的收藏、最近访问等个性化内容。同时,在此区域您还可以反馈对华为云的用户评价和优化建议。 图2 头部名片区域 表1 模块概述和使用 模块 概述 如何使用 账号中心 展示用户账号信息。 单击头像或“已绑定邮箱”,跳转至账号中心,可查看账号基本信息。 单击“已实名认证”,跳转至实名认证,可查看认证信息。 更多信息,请参见账号中心。 资源 提供常见资源创建的便捷入口,同时提供我的收藏、最近访问等个性化内容。 创建资源: 单击“”展示可创建的常见资源。 在展开区域具体资源下方,单击“创建”,进入对应资源的创建页。 我的收藏: 通过服务列表收藏的服务,会展示在此区域。 您还可以单击“添加”,自定义添加主域名是huaweicloud.com或huawei.com的链接,方便您快捷使用。 最近访问:展示最近访问过的云服务,可通过单击服务名称跳转至对应服务页面。 费用 展示待续费资源及当前账户余额。 单击“待续费”,跳转至续费管理,可进行资源续费。 “可用额度”区域,可显示或隐藏当前账户余额。 配置提醒 提供云服务初始化配置或跨服务配置的配置入口。 您可以通过“配置提醒”,查看待处理的配置任务,并根据界面提示完成操作。 单击“配置提醒”,打开“配置提醒”页面。 更多信息,请参见配置提醒。 优化顾问 展示优化顾问服务声明。 单击“优化建议”,跳转至优化顾问服务声明,可以帮助您遵循最佳实践来配置资源,更多信息,请参见优化顾问。
  • 监控、安全、成本等模块概览信息 表2 总览页模块概述和使用 模块 概述 如何使用 云监控 显示资源的监控信息,包括告警级别及各级比告警总次数。 单击“”,跳转至告警记录,可查看所有告警记录。 安全监控 实时监控最新威胁告警事件、最新漏洞风险事件和最新基线。 单击“”,跳转至安全看板,进行事件的查看和处理。 单击“升级”,可将基础版安全云脑升级到更高版本,以获取更全面的安全监控体验。 单击“应急漏洞”,跳转至漏洞管理,可查看历史漏洞信息。 成本概览 显示当月成本和月末预测成本,与上月成本的环比情况,以及当月不同产品类型的成本分布。 单击“”进入成本中心,进行成本的查看和管理。 费用概况 显示客户账户费用信息,包括:可用额度、现金余额、可开票金额、卡券信息。 单击“费用概况”右侧的“”,跳转至费用中心,可查看更多费用相关信息。 单击“充值”、“提现”、“汇款认领”“去开票”,进行相应操作。 单击“代金券”右侧的“”,查看卡券详情。 学习天地 显示云服务相关帮助文档及学习资源,包括华为云入门在线课程、新手入门、KooLabs云实验、最佳实践、视频教程。 帮助中心:帮助中心首页入口。 华为云入门:报名参加在线课程。 新手入门:了解云服务基础。 KooLabs云实验:了解开发者云实验。 最佳实践:学习云服务使用最佳实践。 视频教程:学习云服务相关视频教程。 开发者工具 显示支持的开发者工具,包括API Explorer、Huawei Cloud Toolkit等。 单击“”,跳转至华为云开发者官网,可查看更多开发者相关信息。 单击具体的工具,可跳转至对应操作页面。 公告 展示最新的3个华为云动态。 单击“”,可查看历史公告。 华为云APP下载 显示运营广告内容,提供华为云APP下载方式,使用华为云APP,可随时随地,管控资源。 -
  • 服务视图 服务视图按云服务维度、以卡片形式展示您当前所拥有的全局资源的名称、数量,并支持按区域名、服务名以及资源名进行搜索。 图4 服务视图 当您使用IAM用户登录管理控制台时,可能因权限不足,无法查看资源或对资源进行操作。这时,您需要对IAM用户进行授权。详细操作,请参见控制台首页找不到资源怎么办?。 部分资源可能会由于未接入控制台,而无法在此模块中展示。 单击“已支持的服务和区域”,查看当前已接入控制台的服务以及支持的区域。 单击“我的资源”,查看资源的更多信息。 在服务视图,您可以进行如下操作: 在区域行,可选择展示“全部区域”或“指定区域”的资源。 在搜索框中,可通过服务名或资源名进行搜索,便于快速定位资源。 仅支持搜索已购买或已创建资源。 单击云服务卡片,可跳转至云服务控制台。 单击云服务卡片中的资源数量,可显示资源清单侧滑面板,该面板包含资源在不同区域的数量信息,以及资源的名称、区域、创建时间的列表信息。 单击资源列表中的资源名称,可跳转至对应资源基本信息页面。 图5 资源数量及区域 通过拖动服务卡片或卡片右上角的“”,可以调整服务卡片的位置。 图6 调整卡片位置
  • 待办聚合信息 展示安全告警、资源告警、待续费、配置提醒、优化顾问以及可用额度等待办事项并提供操作入口。 图2 待办聚合信息 表1 模块概述和使用 模块 概述 如何使用 安全告警 展示所有安全告警数量,并单独展示威胁告警数量。 单击告警数量的数字,跳转至安全看板,可查看安全告警详细信息。 资源告警 展示所有资源告警数量,并单独展示紧急告警数量。 单击告警数量的数字,跳转至告警记录,可查看资源告警详细信息。 待续费 展示待续费资源的数量。 单击待续费资源数量的数字,跳转至续费管理,可进行资源续费。 配置提醒 展示待完成的配置任务数量。 单击配置提醒任务数量的数字,打开“配置提醒”页面。 更多信息,请参见配置提醒。 优化顾问 展示待完成的优化顾问任务数量。 优化顾问可以帮助您遵循最佳实践来配置资源。 单击“去开通”,可授权开通优化顾问功能。 单击待优化顾问任务数量的数字,打开“优化顾问”页面,可根据优化顾问建议进行优化。 更多信息,请参见优化顾问。 可用额度 展示当前账户余额。 “可用额度”区域,可显示或隐藏当前账户余额。 单击“充值”,跳转充值,可进行账户充值。
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务信息。 表6 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID,云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 storage_infos 是 Array of StorageInfo objects 待导出数据的云手机信息。 表4 StorageInfo 参数 是否必选 参数类型 描述 phone_id 是 String 云手机ID。 include_files 是 Array of strings 需要导出数据的存储路径,绝对路径,最大长度4096字节。仅支持导出/data和、cache目录下的数据。目前只支持大小写字母、数字、小数点(.)、斜线(/)、中划线(-)、下划线(_)、加号(+)、井号(#)、星号(*)、波浪号(~)、等号这些字符,星号只能在文件路径末尾。文件导出打包时仅保留路径最后一级的文件权限、属主、标签等元数据,如对文件的上层目录权限有要求,建议参考云手机数据备份与恢复。 exclude_files 否 Array of strings 不能导出数据的存储路径。exclude_files优先级比include_files高,如果冲突,exclude_files生效。 路径要求同include_files。 bucket_name 是 String 导出数据存储的OBS桶名。 合法的OBS桶名,3-63个字符,只能由小写字母、数字、中划线(-)和小数点(.)组成。 object_path 是 String 导出数据存储的OBS路径名。 符合OBS的路径名规范,最大长度1024字符。目前只支持大小写字母、数字、小数点(.)、斜线(/)、中划线(-)、下划线(_)、加号(+)、井号(#)、等号这些字符。
  • 请求示例 将手机数据导出到obs桶 POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-storage { "storage_infos" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "include_files" : [ "/data/app", "/data/local", "/data/media" ], "exclude_files" : [ "/data/app/com.xx.xx-*" ], "bucket_name" : "mybucket", "object_path" : "myimage/v1/xxxxx.tar" } ] }
  • 请求示例 购买云手机服务器 POST https://{CPH Endpoint}/v2/{project_id}/cloud-phone/servers { "server_name" : "cph-kertus-1110", "server_model_name" : "physical.kg1.4xlarge.cp", "phone_model_name" : "kg1.cp.c20.d64SSD.e1v1", "image_id" : "20060220200717f201120a2300000e91", "count" : 1, "keypair_name" : "keypair", "ports" : [ { "name" : "myServer1", "listen_port" : 20000, "internet_accessible" : "false" }, { "name" : "myServer2", "listen_port" : 20001, "internet_accessible" : "true" } ], "extend_param" : { "charging_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : 0 }, "tenant_vpc_id" : "fca063f6-b942-42a8-9004-e5545f58d6a2", "nics" : [ { "subnet_id" : "f1cbfc37-eb42-4357-a0ec-9e4f11950908" } ], "public_ip" : { "eip" : { "type" : "5_bgp" } }, "band_width" : { "band_width_share_type" : 0, "band_width_size" : 300, "band_width_charge_mode" : 1 } }
  • 响应示例 状态码:200 OK { "request_id" : "1564567b8bab40f34711234cb80d8574", "order_id" : " CS 1710111105S8IPB", "product_id" : "00301-25217-0--0", "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ] }
  • 响应参数 状态码:200 表13 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 order_id String 订单ID,不超过64个字节。 product_id String 产品ID,不超过64个字节。 server_ids Array of strings 服务器ID列表。 error_msg String 任务错误码说明。 error_code String 任务错误码。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_name 是 String 云手机服务器名称,不超过60个字符,只支持英文字母、数字、汉字、下划线和中划线。批量购买会在服务器名称后自动添加序号,比如设置此参数为server-1,那么创建的云手机服务器名称会自动按序增加数字后缀,比如为server-1-0001。 server_model_name 是 String 云手机服务器规格,不超过64个字节。 phone_model_name 是 String 云手机规格,不超过64个字节。 image_id 是 String 云手机镜像ID,不超过32个字节。 count 是 Integer 购买的云手机服务器个数,最多可购买10台。 keypair_name 否 String 密钥对名称,不超过64个字节,用于云手机ADB登录。 ports 否 Array of Port objects 云手机启用的应用端口,云手机服务会做端口转发。 extend_param 是 extend_param object 计费模式参数。 tenant_vpc_id 是 String 租户自定义的VPC ID,为待创建的云服务器所属的虚拟私有云(简称VPC),需要指定已创建VPC的ID,UUID格式。 nics 是 Array of Nic objects 租户自定义的网卡的结构体,为待创建的云服务器的网卡信息。 public_ip 是 public_ip object 租户自定义的弹性公网IP结构体。 配置云服务器的弹性IP信息的方式, 自动分配,需要指定新创建弹性IP的信息; 使用已有,需要指定已经购买的EIP ID。 phone_count_per_ip 否 Integer 多少个手机共用一个vip。默认为手机开数,表示所有手机共享1个vip。取值范围:1到手机规格开数。 phone_data_volume 否 phone_data_volume object 手机磁盘结构体,2.0规格必选。 server_share_data_volume 否 server_share_data_volume object 共享存储磁盘结构体,2.0规格可选。注:rx7服务器+AOSP11镜像当前不支持共享应用。 band_width 是 band_width object 云手机使用的带宽信息。 availability_zone 否 String 待创建云服务器所在的可用区,需要指定可用区(AZ)的名称。如上海一可用区1为cn-east-3a。 property 否 String 云手机属性列表,为Json格式字符串。只可以预置有权限修改的属性。字符串长度[1,8192]。 表4 Port 参数 是否必选 参数类型 描述 name 是 String 应用端口名称,不超过16个字节,系统关键服务名称不能使用"adb"和"vnc"。 listen_port 是 Integer 端口号,大于等于10000,小于等于50000。 internet_accessible 是 String 为"true"则映射出公网访问(忽略大小写)。 为其他则不映射。 表5 extend_param 参数 是否必选 参数类型 描述 charging_mode 是 Integer 计费类型。 0:包周期 period_type 是 Integer 订购周期类型。 2:月 3:年 period_num 是 Integer 订购周期数。 当订购周期为月时,取值范围[1, 9]。 当订购周期为年时,取值范围[1,10]。 is_auto_pay 否 Integer 是否自动付款。默认不自动付款。 1:自动付款 0:不自动付款 is_auto_renew 否 Integer 是否自动续订。默认不自动续订。 1:自动续订 0:不自动续订 enterprise_project_id 否 String 企业项目ID。 该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。 表6 Nic 参数 是否必选 参数类型 描述 subnet_id 是 String 租户自定义的子网 ID,为待创建的云服务器所属的子网。 需要指定tenant_vpc_id对应VPC下已创建的子网(subnet)的网络ID,UUID格式。 ipv6_enable 否 Boolean 是否支持ipv6。 取值为true时,标识此网卡支持ipv6。 ipv6_bandwidth 否 ipv6_bandwidth object 绑定的共享带宽信息,详情请参见 ipv6_bandwidth数据结构说明。 表7 ipv6_bandwidth 参数 是否必选 参数类型 描述 band_width_id 是 String ipv6绑定的共享带宽ID。 表8 public_ip 参数 是否必选 参数类型 描述 ids 否 Array of strings 指定已有的EIP进行服务器创建,当前只支持传入一个已有的EIP ID。 eip 否 eip object 配置服务器自动分配弹性IP时,创建弹性IP的配置参数,详情见 eip 结构体。 count 否 Integer Eip数量。默认为1,不需要Eip可设置为0,取值范围为0到手机IP数。 表9 eip 参数 是否必选 参数类型 描述 type 是 String 弹性公网IP的类型。 5_telcom:电信 5_union:联通 5_bgp:全动态BGP 5_sbgp:静态BGP 表10 phone_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型,只支持如下类型: SSD GPSSD size 是 Integer 手机磁盘大小,单位GiB,取值范围[10,32768]。 表11 server_share_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型,只支持如下类型: SSD GPSSD size 是 Integer 共享磁盘大小,单位GiB,取值范围[10,32768]。 表12 band_width 参数 是否必选 参数类型 描述 band_width_id 否 String 云手机服务器的带宽唯一标识,选共享带宽时必选。 band_width_size 否 Integer 云手机服务器的带宽大小,选独享带宽时必选。 band_width_charge_mode 是 Integer 云手机服务器带宽的计费方式。 0:bandwidth, 按带宽计费 1:traffic, 按流量计费 band_width_share_type 是 Integer 云手机服务器的带宽类型。 0:per,独享带宽 1:whole,共享带宽
  • 请求示例 批量删除标签 Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/{resource_id}/tags { "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 delete:删除 tags 是 Array of Tag objects 标签列表。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不能为空,可以包含任意语种字母、数字、空格和_.:=+-@,不能以_sys_开头。 value 是 String 值列表。 每个值最大长度255个unicode字符。 不能为空,可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格。
  • 请求示例 切换云手机服务器 POST https://{CPH Endpoint}/v2/{project_id}/cloud-phone/servers/{server_id}/change { "phone_model_name" : "kg1.cp.c20.d64SSD.e1v1", "image_id" : "20060220200717f201120a2300000e91", "keypair_name" : "keypair", "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}", "ports" : [ { "name" : "myServer1", "listen_port" : 20000, "internet_accessible" : "false" }, { "name" : "myServer2", "listen_port" : 20001, "internet_accessible" : "true" } ], "extend_param" : { "enterprise_project_id" : "0" }, "tenant_vpc_id" : "fca063f6-b942-42a8-9004-e5545f58d6a2", "nics" : [ { "subnet_id" : "f1cbfc37-eb42-4357-a0ec-9e4f11950908" } ], "public_ip" : { "eip" : { "type" : "5_bgp" } }, "band_width" : { "band_width_share_type" : 0, "band_width_size" : 300, "band_width_charge_mode" : 1 } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 phone_model_name 是 String 云手机规格,不超过64个字节。 image_id 是 String 云手机镜像ID,不超过32个字节。 keypair_name 否 String 密钥对名称,不超过64个字节,用于云手机ADB登录。 availability_zone 否 String 云手机服务器所在的可用区,不填则维持原可用区不变。如上海一可用区1为cn-east-3a。 ports 否 Array of Port objects 云手机启用的应用端口,云手机服务会做端口转发。 extend_param 否 extend_param object 扩展字段。 tenant_vpc_id 是 String 租户自定义的VPC ID,为待创建的云服务器所属的虚拟私有云(简称VPC),需要指定已创建VPC的ID,UUID格式。 nics 是 Array of Nic objects 租户自定义的网卡的结构体,为待创建的云服务器的网卡信息。 public_ip 是 public_ip object 租户自定义的弹性公网IP结构体。 配置云服务器的弹性IP信息的方式, 自动分配,需要指定新创建弹性IP的信息; 使用已有,需要指定已经购买的EIP ID。 phone_count_per_ip 否 Integer 多少个手机共用一个vip。默认为手机开数,表示所有手机共享1个vip。取值范围:1到手机规格开数。 phone_data_volume 否 phone_data_volume object 手机磁盘结构体,2.0规格必选。 server_share_data_volume 否 server_share_data_volume object 共享存储磁盘结构体,2.0规格可选。注:rx7服务器+AOSP11镜像当前不支持共享应用。 band_width 是 band_width object 云手机使用的带宽信息。 property 否 String 云手机属性列表,为Json格式字符串。只可以预置有权限修改的属性。字符串长度[1,8192]。 表4 Port 参数 是否必选 参数类型 描述 name 是 String 应用端口名称,不超过16个字节,系统关键服务名称不能使用"adb"和"vnc"。 listen_port 是 Integer 端口号,大于等于10000,小于等于50000。 internet_accessible 是 String 为"true"则映射出公网访问(忽略大小写)。 为其他则不映射。 表5 extend_param 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID。 该字段不传(或传为字符串“0”),则将资源绑定给默认企业项目。 表6 Nic 参数 是否必选 参数类型 描述 subnet_id 是 String 租户自定义的子网 ID,为待创建的云服务器所属的子网。 需要指定tenant_vpc_id对应VPC下已创建的子网(subnet)的网络ID,UUID格式。 ipv6_enable 否 Boolean 是否支持ipv6。 取值为true时,标识此网卡支持ipv6。 ipv6_bandwidth 否 ipv6_bandwidth object 绑定的共享带宽信息,详情请参见 ipv6_bandwidth数据结构说明。 表7 ipv6_bandwidth 参数 是否必选 参数类型 描述 band_width_id 是 String ipv6绑定的共享带宽ID。 表8 public_ip 参数 是否必选 参数类型 描述 ids 否 Array of strings 指定已有的EIP进行服务器创建,当前只支持传入一个已有的EIP ID。 eip 否 eip object 配置服务器自动分配弹性IP时,创建弹性IP的配置参数,详情见 eip 结构体。 count 否 Integer Eip数量。默认为1,不需要Eip可设置为0,取值范围为0到手机IP数。 表9 eip 参数 是否必选 参数类型 描述 type 是 String 弹性公网IP的类型。 5_telcom:电信 5_union:联通 5_bgp:全动态BGP 5_sbgp:静态BGP 表10 phone_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型,只支持如下类型: SSD GPSSD size 是 Integer 手机磁盘大小,单位GiB,取值范围[10,32768]。 表11 server_share_data_volume 参数 是否必选 参数类型 描述 volume_type 是 String 磁盘类型,只支持如下类型: SSD GPSSD size 是 Integer 共享磁盘大小,单位GiB,取值范围[10,32768]。 表12 band_width 参数 是否必选 参数类型 描述 band_width_id 否 String 云手机服务器的带宽唯一标识,选共享带宽时必选。 band_width_size 否 Integer 云手机服务器的带宽大小,选独享带宽时必选。 band_width_charge_mode 是 Integer 云手机服务器带宽的计费方式。 0:bandwidth, 按带宽计费 1:traffic, 按流量计费 band_width_share_type 是 Integer 云手机服务器的带宽类型。 0:per,独享带宽 1:whole,共享带宽
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 tags Array of Tags objects 资源标签列表。 表5 Tags 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 key不能为空。 values Array of strings 值列表。 最多10个value。 value不允许重复。 每个值最大长度255个unicode字符。 如果values为空则表示any_value。 value之间为或的关系。
  • URI GET /v1/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 resource_type 是 String 资源类型。 cph-server,云手机服务器 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页返回的资源个数。取值范围:1~100(默认值为100),一般设置为10、20、50。 offset 否 Integer 索引位置,从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数
  • 响应示例 状态码:200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "error_code" : "CPS.0004", "error_msg" : "Parameter: phone_id is invalid." } ] }
  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务信息。 表6 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID,云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 phones 是 Array of PhoneDataVolumeSize objects 云手机列表。 表4 PhoneDataVolumeSize 参数 是否必选 参数类型 描述 phone_id 是 String 云手机id new_size 是 Integer 扩容后的手机数据盘大小,单位为GiB。扩容的大小必须大于等于原有容量且小于最大容量。 最大容量:32768GiB
  • 响应示例 状态码: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" : "endpoint/namespace/image-name" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 最小长度:1 最大长度:32768
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 count Integer 参数解释: 镜像版本总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 tags Array of GetTagDetailRsp objects 参数解释: 镜像版本详情列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 表4 GetTagDetailRsp 参数 参数类型 描述 tag String 参数解释: 镜像版本名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 size Long 参数解释: 镜像版本大小。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 create_time String 参数解释: 镜像版本创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 update_time String 参数解释: 镜像版本更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 path String 参数解释: 镜像地址。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/images/{image_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 参数解释: 空间ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128 image_id 是 String 参数解释: 镜像ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、下划线和中划线。长度应在1-128之间。 默认取值: 不涉及 最小长度:1 最大长度:128 project_id 是 String 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128
  • 请求示例 创建自由能微扰作业,作业名称为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 参数解释: 受体文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 add_membrane 否 Boolean 参数解释: 是否加膜处理。 约束限制: 不涉及 取值范围: true:加膜。 false:不加膜。 默认取值: false ligands 是 Array of LigandPreviewDto objects 参数解释: 配体列表。 约束限制: 配体数量范围为[2-101]。 取值范围: 不涉及 默认取值: 不涉及 graph 是 FepGraphDto object 参数解释: 路径图。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 params 是 FepParamDto object 参数解释: FEP设置参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 表4 CreateDrugJobBasicInfo 参数 是否必选 参数类型 描述 name 是 String 参数解释: 作业名称。 约束限制: 不涉及 取值范围: 长度范围[5-64],允许大小写字母、数字、空格、下划线(_)和中划线(-),只能以数字或字母开头。 默认取值: 不涉及 labels 否 Array of strings 参数解释: 标签。 约束限制: 标签数量范围为[0-5],单个标签长度为[1-32]个字符,支持中文、字母、数字、空格、下划线(_)和中划线(-),且不能以空格开头或结尾。 取值范围: 不涉及 默认取值: 不涉及 upstream_job_info 否 String 参数解释: 上游作业信息。 约束限制: 不涉及 取值范围: 长度为[1-10240]个字符。 默认取值: 不涉及 表5 ReceptorDrugFile 参数 是否必选 参数类型 描述 source 是 String 参数解释: 受体的数据源。 约束限制: 不涉及 取值范围: EXTRANET:外部网络数据 PRIVATE:私有数据 PUBLIC:公共数据 RAW :源数据 默认取值: 不涉及 url 否 String 参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL仅支持以.pdb格式结尾,长度为[1-2000]个字符。 默认取值: 不涉及 format 否 String 参数解释: 文件格式。 约束限制: 仅数据源source为RAW时提供。 取值范围: PDB:PDB文件 默认取值: 不涉及 data 否 String 参数解释: 文件原始数据。 约束限制: 仅数据源source为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 参数解释: 受体的数据源。 约束限制: 不涉及 取值范围: EXTRANET:外部网络数据 PRIVATE:私有数据 PUBLIC:公共数据 RAW :源数据 默认取值: 不涉及 url 否 String 参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL仅支持以.pdb、.mol2、.sdf、.smi为结尾,长度为[1-2000]个字符。 默认取值: 不涉及 format 否 String 参数解释: 文件格式。 约束限制: 仅数据源source为 RAW 时提供。 取值范围: PDB SDF MOL2 SMI 默认取值: 不涉及 data 否 String 参数解释: 文件原始数据。 约束限制: 仅数据源source为RAW时提供。 取值范围: 长度为[0-10000000]个字符。 默认取值: 不涉及 表8 FepGraphDto 参数 是否必选 参数类型 描述 center_id 是 String 参数解释: 中心配体名称。 约束限制: 不涉及 取值范围: 长度为[1-32]个字符。 默认取值: 不涉及 pairs 是 Array of SimilarityDto objects 参数解释: 配体对列表。 约束限制: 配体长度为[1-100]。 取值范围: 不涉及 默认取值: 不涉及 表9 SimilarityDto 参数 是否必选 参数类型 描述 ligand_ids 是 Array of strings 参数解释: 配体对。 约束限制: 配体固定数量为2,配体长度为[1-32]个字符。 取值范围: 不涉及 默认取值: 不涉及 表10 FepParamDto 参数 是否必选 参数类型 描述 pre_equilibrium_time 否 Float 参数解释: 预平衡时长。 约束限制: 不涉及 取值范围: 范围为(0,200],单位为ps。 默认取值: 100 equilibrium_time 否 Float 参数解释: 平衡时长。 约束限制: 不涉及 取值范围: 范围为(0,10],单位为ns。 默认取值: 1 num_pre_equilibrium_steps 否 Integer 参数解释: 预平衡步数。 约束限制: 不涉及 取值范围: 1-200000 默认取值: 50000 num_equilibrium_steps 否 Integer 参数解释: 平衡步数。 约束限制: 不涉及 取值范围: 1-10000000 默认取值: 500000 timestep_size 否 Float 参数解释: 时间步长,单位ps。 约束限制: 不涉及 取值范围: 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]个字符。 默认取值: 不涉及
  • 响应示例 状态码:200 OK { "count" : 1, "projects" : [ { "id" : "eihealth_project_id", "name" : "eihealth_project_name", "role_type" : "Owner", "creator" : "creator", "create_time" : "2025-01-02T10:50:59Z", "update_time" : "2025-01-02T10:50:59Z", "top_time" : "2025-01-02T10:50:59Z", "user_statistics" : [ { "resource_name" : "app", "count" : 1 }, { "resource_name" : "workflow", "count" : 2 }, { "resource_name" : "job", "count" : 3 }, { "resource_name" : "drug_job", "count" : 4 } ], "total_statistics" : [ { "resource_name" : "app", "count" : 1 }, { "resource_name" : "workflow", "count" : 2 }, { "resource_name" : "job", "count" : 3 }, { "resource_name" : "drug_job", "count" : 4 } ] } ] }
共94790条