华为云用户手册

  • 变更配置后对计费的影响 当前包年/包月的AstroZero套餐的规格不能满足您的业务需要时,可以在控制台发起升级规格操作。AstroZero支持免费版升级标准版或专业版,标准版升级至专业版,变更时系统将按照如下规则为您计算变更费用: 套餐版本升级:新套餐版本价格高于老套餐版本价格,此时您需要支付新老版本的差价。 升级版本费用 = 升级后版本价格 * 剩余周期 - 未升级版本价格 * 剩余周期 剩余周期计算示例: 2023/11/1客户购买了3年的AstroZero,有效期截止到2026/11/1,客户在2024/5/1发生变更,则剩余周期=2024年剩余周期+2025年剩余周期+2026年剩余周期=244/365+1+305/365=2.50(年)。
  • 计费周期 包年/包月AstroZero资源的计费周期是根据您购买的时长来确定的(以UTC+8时间为准)。一个计费周期的起点是您开通或续费资源的时间(精确到秒),终点则是到期日的23:59:59。 例如,如果您在2023/03/08 15:50:04购买了一个时长为一个月的AstroZero专业版实例,那么其计费周期为:2023/03/08 15:50:04 ~ 2023/04/08 23:59:59。
  • 计费示例 假设您在2023/03/08 15:50:04购买了一个包年/包月的AstroZero实例(用户数:35人,版本:专业版)。购买时长为一个月,并在到期前手动续费1个月,则: 第一个计费周期为:2023/03/08 15:50:04 ~ 2023/04/08 23:59:59 第二个计费周期为:2023/04/08 23:59:59 ~ 2023/05/08 23:59:59 图中价格仅供参考,实际计算请以Astro轻应用价格详情中的价格为准。 图1 包年/包月AstroZero费用计算示例
  • 克隆标准页面 标准页面创建后,支持将标准页面克隆到当前应用中。例如,应用A中存在两个或多个功能类似的标准页面,此时可基于已创建的标准页面克隆出一个新标准页面,基于克隆后的标准页面进行修改,减少重复创建的操作。 参考登录AstroZero新版应用设计器中操作,进入应用设计器。 在应用设计器的左侧导航栏中,选择“界面”。 在页面中,将鼠标放在对应的标准页面上,单击,选择“克隆”。 输入标准页面的名称和唯一标识,单击“确认”。 克隆成功后,自动进入克隆后的标准页面。
  • 移动标准页面 标准页面创建后,支持将标准页面移动到拥有开发权限的应用中。例如,A应用中创建的标准页面,在B应用中也会用到,为避免多次重复创建,可以将A中的标准页面先克隆,再移动到B应用中。 参考登录AstroZero新版应用设计器中操作,进入应用设计器。 在应用设计器的左侧导航栏中,选择“界面”。 在页面中,将鼠标放在对应的标准页面上,单击,选择“移动”。 选中需要移动的标准页面,单击“下一步”。 选择目标应用,单击“确认”。
  • 操作场景 应用即一个App,是一个实现了某种业务管理的可运行应用程序。创建应用是在低代码中开发项目的第一步,也是端到端构建软件应用的入口。在开发项目工程前,请先创建一个应用,再在应用中进行前端开发、后端开发和集成开发。 AstroZero 低代码开发平台 支持通过“拖、拉、拽”创建前端页面,可视化排列、配置各种逻辑模块化元素,创建功能各异的应用。本章节主要向您介绍,如何使用AstroZero快速创建一个空白的应用。
  • 事件分类 AstroZero低代码中的事件,分为标准事件和自定义事件两种。 标准事件是系统定义好的事件,可直接订阅。标准事件目前有几下几种: Absolute Time Alert:定时器发送的系统事件。 EV_FLOW_STARTED:流程启动,用于记录工作流的启动。 EV_FLOW_TERMINATED:流程终止,用于记录工作流的流程结束。 EV_FLOW_REVOKED:流程撤回,用于记录工作流的撤回。 EV_TASK_STARTED:任务启动,用于记录人工任务启动。 EV_TASK_TERMINATED:任务终止,用于记录人工任务结束。 自定义事件是指用户根据自身业务需求,自行定义的事件。例如,在某个公司招聘场景中,招聘人员A和招聘经理B负责面试,招聘经理B负责决定该应聘者是否被录用,录用后,人事部C来给新员工办理各种手续。需要进行软件设计,一旦应聘者被录用后,不需要招聘经理自己去通知人事部,而是创建一个记录应聘者录用结果状态的事件,通过订阅该事件,系统根据状态结果自动发邮件给人事部,通知人事部是否办理入职手续。
  • 沙箱环境 在应用正式发布上线前,需要在测试环境进行测试,包含数据配置。AstroZero一般以沙箱(Sandbox)环境,来作为测试环境。沙箱环境默认 域名 为“appcubesandbox.cn-north-4.huaweicloud.com”。 使用沙箱环境前,首先需要了解什么是沙箱。沙箱是一种安全机制,为运行中的程序提供的隔离环境。通常作为一些来源不可信、具破坏力或无法判定程序意图的程序,提供实验之用。沙箱是一种按照安全策略,限制程序行为的执行环境。在沙箱中,网络访问、对真实系统的访问、对输入设备的读取,通常被禁止或是严格限制的。沙箱属于虚拟化的一种,沙箱中的所有改动对操作系统不会造成任何损失。关于沙箱的更多介绍,请参见购买AstroZero沙箱实例。
  • 标准页面 标准页面基于Vue技术栈,平台预置丰富基础组件,也可以支持扩展,多用于表格表单等后端管理页面的快速开发。 标准页面开发界面提供图形化、无码化在线页面开发功能,通过标准页面开发界面能够快速构建各种复杂表单表格页面、以及其他一些灵活布局页面。支持在开发界面中将组件面板上的页面组件拖拽至页面工作区域,并对组件的属性、事件进行设置,再配合事件编排完成复杂的业务功能。支持用户以积木组装的方式快速构建应用页面,提升开发效率和质量,及时响应业务需求和价值实现。更多内容请参见标准页面。
  • 命名空间 由于不同租户间的数据可打包共享,为了避免数据命名的重复(例如数据对象、应用、服务编排等),租户在首次创建应用前,需要先定义一个命名空间。 命名空间唯一且每个租户只能创建一个命名空间。命名空间一旦设定不能修改,请慎重定义,建议使用公司或团队的缩写作为命名空间。命名空间创建后,后续创建的应用、数据对象、脚本、服务编排、页面等应用元素的名称前,系统会为其增加命名空间。例如,将命名空间定义为“CNAME”,后续创建的所有应用、应用元素(数据对象、脚本、页面等)都将以“CNAME__”开头。
  • 产品规格差异 AstroZero提供了免费版、标准版、专业版和专享版四种规格套餐,各套餐的功能说明如表1所示,具体计费详情请参见AstroZero价格详情。 免费版:免费使用,最多可添加10个用户(包括业务用户),可以使用的资源有限,免费版提供开发环境和开发零代码应用的运行环境,不提供低代码应用的运行环境。 标准版:适用于零代码应用开发场景,开发者不需要有代码开发经验,企业自用首选。 专业版:专业版在标准版基础上提供了低代码应用运行环境(多租户共享运行环境),且提供了更多功能和资源,适用于专业开发者。 专享版:使用专享版前,请确认已提交工单申请开通专享版,否则,您将无法购买专享版。专享版提供了物理隔离的运行环境,运行环境实例发放到租户虚拟私有云中。 专业版和专享版支持回退到免费版,回退后不支持访问运行环境。 应用正式发布上线前,需要在测试环境上进行测试,AstroZero使用沙箱环境作为测试环境,四种规格套餐均支持购买沙箱。 表1中的“不限制”,是在系统允许的范围内不进行限制。若想了解更多,请参考AstroZeroLicense。 表1 套餐规格说明 功能特性 免费版 标准版 专业版 专享版 用户数 业务用户数 总数默认最多10个,不支持扩展用户。 总数默认最多30个,支持扩展用户。 总数默认最多30个,支持扩展用户。 500 2000 5000 开发者账号数 扩展用户/新增用户 不支持 9元/用户/月 39元/用户/月 不支持 零代码应用构建 内部分享 支持 支持 支持 支持 公开分享 支持 支持 支持 支持 附件上传 不支持 支持 支持 支持 低代码应用开发 企业应用开发 支持 支持 支持 支持 资产开发 支持 支持 支持 支持 低代码应用数(除了BO和Native Service,其他所有类型的定制应用数) 10 50 不限 不限 物联接入 不支持 不支持 支持 支持 原生服务接入 不支持 不支持 支持 支持 发布移动应用 不支持 不支持 支持 支持 应用运行 运行零代码应用 支持 支持 支持 支持 零代码应用数 100 不限 不限 不限 数据量(租户级) 1万条(不支持扩容) 4000条/用户 4000条/用户(支持单独扩容) 500人:200G 2000人:800G 5000人:2T 运行低代码应用 不支持 不支持 支持 支持 低代码应用数 不支持 不支持 不限 不限 物联接入调用次数(租户级) 不支持 不支持 2500次/用户/天 次数不限制 环境管理 租户子域名 支持 支持 支持 支持 开发环境 支持 支持 支持 支持 商用运行环境 不支持 共享环境(多租户共享运行环境) 共享环境(多租户共享运行环境) 独享运行环境、物理隔离 企业独立域名 不支持 不支持 支持 支持,可独立域名 调测沙箱 不支持 不支持 按需购买沙箱 按需购买沙箱 租户级日志服务 不支持 不支持 支持 支持
  • libqtsm与SDK使用示例 本节主要基于开源示例代码来介绍如何在QingTian Enclave应用程序中使用libqtsm与SDK接口。本节中提供的示例程序只支持在Linux环境下运行。 安装libqtsm开发包: yum install libqtsm-devel 获取开源示例代码,拷贝至enclave镜像创建环境中,地址如下: https://gitee.com/HuaweiCloudDeveloper/huawei-qingtian/tree/master/enclave/qtsm 创建一个Dockerfile文件,内容如下: # start the Docker image from ubuntu FROM ubuntu AS base-img WORKDIR /home/builder # COPY libqtsm example COPY ./qtsm qtsm_tests/ # install relative dependencies RUN apt-get update && \ apt-get install gcc -y && \ apt-get install make -y && \ apt-get install libssl-dev -y && \ apt-get install libglib2.0-dev -y && \ apt-get install curl -y && \ apt-get install libcurl4-openssl-dev –y && \ apt-get install -y libcbor-dev && \ apt-get install -y libjson-c-dev # build a test demo RUN cd qtsm_tests/tests/ && \ make RUN cp /home/builder/qtsm_tests/tests/gtest_libqtsm /root/ # Launch a client CMD "/root/gtest_libqtsm" 构建docker镜像,将docker镜像装换为enclave镜像并启动enclave。 获取SDK接口的开源示例代码,地址如下: https://gitee.com/HuaweiCloudDeveloper/huawei-qingtian/tree/master/enclave/qtsm-sdk-c/samples
  • QingTian Enclave SDK QingTian Enclave SDK由一系列开源库组成,以便您开发自己的QingTian Enclave应用程序。其中包括QingTian安全模块(QingTian Security Module,QTSM)提供的qtsm-lib函数库。此外,SDK集成了KMS接口,该接口内置了获取证明文档及调用华为云KMS相关服务的功能。在典型使用案例里,我们描述了在QingTian Enclave调用KMS解密接口的实例。 表1 接口介绍 类型 接口 接口描述 libqtsm接口 qtsm_describe_pcr 查询指定index的PCR数据信息 qtsm_extend_pcr 扩展指定index对应的PCR值 qtsm_lock_pcr 锁定指定index的PCR数据信息 qtsm_lock_pcrs 批量锁定指定index对应的PCR值 qtsm_get_describe 获取qtsm信息 qtsm_get_attestation 获取Attestation Doc qtsm_get_random 获取硬件随机数 KMS接口 kms_generate_datakey_blocking 生成新的密钥对,获取公钥与私钥 kms_generate_datakey_blocking_with_proxy 集成qtproxy代理的密钥对获取接口 kms_gen_random_blocking 获取随机数 kms_gen_random_blocking_with_proxy 集成qtproxy代理的随机数获取接口 kms_decrypt_data_blocking 解密数据 kms_decrypt_data_blocking_with_proxy 集成qtproxy代理的解密数据接口 源码可以在开源仓库https://gitee.com/HuaweiCloudDeveloper/huawei-qingtian/tree/master/enclave免费获取,您可以基于测试示例开发自己的QingTian Enclave应用程序。
  • URI GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}¬-tags={not-tags}&reservation_id={reservation_id}&enterprise_project_id={enterprise_project_id}&tags={tags}&ip={ip} 参数说明请参见表1。 表1 路径参数 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 offset 否 Integer 页码。 当前页面数,默认值为1,取值范围大于等于0。 当取值为0时,系统默认返回第1页,与取值为1时相同。 建议设置该参数大于等于1。 flavor 否 String 云主机规格ID。 name 否 String 名称,匹配规则为模糊匹配。 支持特殊字符,例如,"." 匹配除换行符(\n、\r)之外的任何单个字符,相等于 [^\n\r]。 status 否 String 云主机状态。 取值范围: ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN 状态说明请参考云服务器状态。 说明: 当处于中间状态时,查询范围如下: ACTIVE,查询范围:ACTIVE,REBOOT,HARD_REBOOT,REBUILD,MIGRATING、RESIZE SHUTOFF,查询范围:SHUTOFF,RESIZE,REBUILD ERROR,查询范围:ERROR,REBUILD VERIFY_RESIZE,查询范围:VERIFY_RESIZE,REVERT_RESIZE limit 否 Integer 查询返回列表当前页面的数量。 每页默认值是25,最多返回1000台的信息,如果数据量过大建议设置成100。 tags 否 String 查询tag字段中包含该值的。 not-tags 否 String 查询tag字段中不包含该值的。 示例:查询的列表中不包含裸金属服务器,该字段设置如下:not-tags=__type_baremetal reservation_id 否 String 使用Openstack Nova 接口批量创建时,会返回该ID,用于查询本次批量创建的。 enterprise_project_id 否 String 查询绑定某个企业项目的。 若需要查询当前用户所有企业项目绑定的,请传参all_granted_eps。 说明: 查询的企业项目需具备ecs:cloudServers:list的权限。 如果用户只有某个企业项目的权限,则需要传递该参数,查询指定企业项目绑定的,否则会因权限不足而报错。 当前all_granted_eps支持查询的企业项目个数不超过100。 ip 否 String IPv4地址过滤结果,匹配规则为模糊匹配。 此处IP为的私有IP。 ip_eq 否 String IPv4地址过滤结果,匹配规则为精确匹配。 此处IP为云主机的私有IP。 server_id 否 String 云主机ID,格式为UUID,匹配规则为精确匹配 示例:server_id={id1}&server_id={id2} 说明: 在使用server_id作为过滤条件时,不能同时使用其他过滤条件。如果同时指定server_id及其他过滤条件,则以server_id条件为准,其他过滤条件会被忽略 当server_id中含有不存在的云主机ID时,返回的响应参数中该云主机ID对应的servers结构体中除了id和fault其它字段均为null 为了避免API的URI过长,建议一次查询的server_id个数不超过100个
  • 请求消息 表2 表2 请求参数 参数 是否必选 参数类型 描述 os-stop 是 Object 标记为关闭云主机操作,详情请参见表3。 表3 表3 os-stop字段数据结构说明 参数 是否必选 参数类型 描述 servers 是 Array of objects 云主机ID列表,详情请参见表4。 type 否 String 关机类型,默认为SOFT: SOFT:普通关机(默认)。 HARD:强制关机。 表4 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", // IAM 用户名 "password": $ADMIN_PASS, //IAM用户密码,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • 请求消息 表2 表2 请求参数 参数 是否必选 参数类型 描述 os-start 是 Object 标记为启动云主机操作,详情请参见表3。 表3 表3 os-start字段数据结构说明 参数 是否必选 参数类型 描述 servers 是 Array of objects 云主机ID列表,详情请参见表4。 表4 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,$ADMIN_PASS表示用户登录密码,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": "$ADMIN_PASS", //建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的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-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 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
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求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在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求消息 表2 表2 请求参数 参数 是否必选 参数类型 描述 reboot 是 Object 标记为重启云主机操作,详情请参见表3。 表3 表3 reboot字段数据结构说明 参数 是否必选 参数类型 描述 type 是 String 重启类型: SOFT:普通重启。 HARD:强制重启。 servers 是 Array of objects 云主机ID列表,详情请参见表4。 表4 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • 接口约束 使用此API,需预先安装重置密码插件。 Flexus L实例 提供的系统镜像、应用镜像默认已安装重置密码插件。 如果私有镜像的镜像源来自其他云平台的服务器或从第三放下载,此类私有镜像可能因为未安装一键式密码重置插件而无法重置密码。请根据重置Linux云服务器云主机密码(未安装重置密码插件)安装插件。 云主机的重置密码请求下发后,脚本执行失败,该API不会报错。 云主机开机或重启后,新密码生效。 该接口支持虚拟机状态为开机或者关机状态下执行。
  • 请求消息 请求参数如表2 请求参数所示。 表2 请求参数 参数 参数类型 是否必选 描述 new_password String 是 新密码。 当dry_run字段为true时,该字段为非必填字段,否则为必填字段。 新密码的校验规则: 长度为8-26位。 密码至少必须包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(!@%-_=+[]:./?)中的三种。 密码不能包含用户名或用户名的逆序。 Windows系统密码不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。 dry_run Boolean 否 是否只预检此次请求。取值为true或false,默认值为false。 true:发送检查请求,不会重置密码。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应结果。 false:发送正常请求,通过检查后并且进行重置密码请求。 servers Array of objects 是 待批量重置密码的云主机ID信息,详情参见表3 servers字段数据结构说明。 表3 表4 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 云主机ID。
  • 概述 欢迎使用Flexus应用服务器L实例。Flexus应用服务器L实例是新一代开箱即用、面向中小企业和开发者打造的全新轻量级云服务器产品系列。Flexus应用服务器L实例提供丰富严选的应用镜像,实现应用一键部署,适用于网站搭建、开发测试环境、企业应用、网站分析、音视频服务等中低负载场景。具有易搭建、更实惠、易维护、更安全的特点。 本文档提供了Flexus应用服务器L实例API的描述、语法、参数说明及示例等内容。支持的全部操作请参见API概览。 在调用Flexus应用服务器L实例API之前,请确保已经充分了解Flexus应用服务器L实例相关概念,详细信息请参见什么是Flexus应用服务器L实例。 在Flexus应用服务器L实例文档中,“Flexus应用服务器L实例”简称为“Flexus L实例”。
  • API概览 Flexus L实例是包含了云主机、弹性公网IP、云硬盘、云备份、主机安全、Flexus负载均衡的服务组合,云主机是Flexus L实例中的服务器。 本文提供了部分Flexus L实例云主机的API接口供您操作。在使用API前,请先了解如何调用API以便顺利使用API。 表1 接口说明 接口 说明 查询云主机详情 查询云主机的详细信息,包括云主机的运行状态、云主机名称、公网IP等。 批量启动云主机 根据指定的云主机ID列表,批量开机云主机。 批量重启云主机 根据指定的云主机ID列表,批量重启云主机。 批量关闭云主机 根据指定的云主机ID列表,批量关机云主机。 批量重置云主机密码 批量重置云主机管理账号(root用户或Administrator用户)的密码。 修改云主机信息 修改云主机信息,目前支持修改云主机名称及描述和hostname。
  • 流水线官方插件 流水线当前内置的官方插件如表1。 表1 流水线官方插件 插件类型 插件名 插件使用介绍 构建 Build构建 调用编译构建能力进行构建。编译构建服务为开发者提供配置简单的混合语言构建平台,实现编译构建云端化,支撑企业实现持续交付,缩短交付周期,提升交付效率。支持编译构建任务一键创建、配置和执行,实现获取代码、构建、打包等活动自动化,实时监控构建状态,让您更加快速、高效地进行云端编译构建。了解更多。 Build构建(模板) 仅支持在流水线模板中配置,该插件会在通过模板生成流水线时,依照当前配置的构建任务模板,自动创建构建任务并配置到所生成的流水线中。 测试 TestPlan接口测试 调用CodeArts TestPlan能力进行测试。测试计划是面向软件开发者提供的一站式云端测试平台,覆盖测试管理、接口测试,融入DevOps敏捷测试理念,帮助您高效管理测试活动,保障产品高质量交付。了解更多。 TestPlan接口测试(模板) 仅支持在流水线模板中配置,该插件会在通过模板生成流水线时,自动创建接口测试任务并配置到所生成的流水线中。 部署 Deploy部署 调用CodeArts Deploy能力进行部署。部署服务(CodeArts Deploy)提供可视化、一键式部署服务,支持部署到虚拟机或者容器,提供Tomcat、SpringBoot等模板或者自由组装编排原子步骤进行部署,支持并行部署和流水线无缝集成,实现部署环境标准化和部署过程自动化。了解更多。 Deploy部署(模板) 仅支持在流水线模板中配置,该插件会在通过模板生成流水线时,依照当前配置的部署任务模板,自动创建部署任务并配置到所生成的流水线中。 Kubernetes发布 将容器镜像部署到云容器引擎(CCE)或原生Kubernetes集群中。支持滚动发布和基于集群Service的蓝绿发布。 云原生发布 云原生发布提供了环境级别的服务发布能力,支持对环境进行自定义编排发布(例如:滚动发布和灰度发布)。 代码检查 Check代码检查 调用CodeArts Check能力进行代码检查。代码检查服务(CodeArts Check)是基于云端实现代码质量管理的服务,软件开发者可在编码完成后执行多语言的代码静态检查和安全检查,获取全面的质量报告,并提供缺陷的改进建议和趋势分析,有效管控代码质量,降低成本。了解更多。 Check代码检查(模板) 仅支持在流水线模板中配置,该插件会在通过模板生成流水线时,自动创建代码检查任务并配置到所生成的流水线中。 分支变动检查 指定目标分支,若当前流水线运行分支落后于指定分支,则流水线运行失败。 通用 创建仓库标签 为代码仓创建标签并推送。 子流水线 配置并调用项目下其他流水线任务。 Jenkins任务 调用Jenkins任务以扩展并实现自定义动作。 挂起流水线 配置以挂起当前流水线。 延时执行 暂停流水线运行一段时间或暂停至指定时间点,用户可以手动继续、终止流水线运行或进行至多3次的额外延时。 人工审核 以单签或会签的方式配置人工审核任务,配置后将以邮件通知的方式提醒审核人审核。 下载仓库 下载流水线源中配置的代码库,可结合执行shell命令、Maven构建等插件使用。 执行shell 用于执行shell命令。 钉钉机器人 在流水线上配置钉钉机器人的webhook,向机器人发送自定义内容。 飞书机器人 在流水线上配置飞书机器人的webhook,向机器人发送自定义内容。 微信机器人 在流水线上配置企业微信机器人的webhook,向机器人发送自定义内容。 上传文件至OBS 将文件上传至华为云OBS。 OBS文件下载 从OBS下载文件至本地。 微服务 创建集成分支 基于微服务默认分支创建集成分支,用于微服务变更流水线运行使用,由变更流水线自动配置,不支持手动配置。 合并集成分支 在微服务变更流水线运行期间,将变更特性分支合并到集成分支,由变更流水线自动配置,不支持手动添加。 合并主干 在微服务变更流水线运行期间,将集成分支合并回微服务默认分支,由变更流水线自动配置,不支持手动添加。 准出条件 标准策略准出条件 选择一个标准插件策略用于门禁拦截。 父主题: 管理流水线扩展插件
  • 授权流水线服务 流水线权限从上到下可以分成三个层级,分别控制不同模块不同粒度的用户行为。 表1 流水线权限 层级 模块 描述 租户级权限 扩展插件、策略(租户级)、租户级规则、流水线模板 控制租户账号下的模块资源,在 统一身份认证 服务中进行配置,生效范围为整个租户下的全部项目。 项目级权限 流水线、策略(项目级)、微服务、变更、环境 控制某一具体项目下的模块资源,在项目中进行配置,生效范围为整个项目下的全部资源。 资源级权限 流水线任务 控制某一具体流水线任务的操作权限,在流水线任务中进行配置,生效范围为当前流水线任务。
  • 配置流水线项目级策略 项目级策略是一种项目级别的资源,可应用于当前项目下所有流水线的准出条件。 访问CodeArts Pipeline首页,进入项目下流水线。 单击“策略”,进入项目级策略列表页面。 单击“新建策略”,进入“新建策略”页面,填写参数信息。 表4 项目级策略参数信息 参数项 说明 名称 策略名称,默认根据当前时间生成。支持输入中文、大小写英文字母、数字、“-”、“_”,长度不超过128个字符。 规则 选中的规则会在界面右侧展示,可对每条规则进行如下操作: 编辑:单击规则右上方“详情”,可查看规则详情,继续单击右上方“编辑”,可修改规则。 开关:单击规则右上方,可打开/关闭规则,关闭后,该规则在应用到流水线准出条件中会自动关闭并不做拦截校验。 说明: 单个策略中最多可配置20个规则。 单击“确定”,即可在策略列表生成一条项目级策略。 在策略列表页面,单击列表右侧,可编辑策略。 在策略列表页面,单击列表右侧,可查看策略,继续单击右上方“编辑”,可编辑策略。 在策略列表页面,单击列表右侧,选中“复制”,可基于当前策略快速复制一个策略。 在策略列表页面,单击列表右侧,选中“删除”,弹出删除警告对话框,确认后单击“删除”,可删除策略。 删除策略时,系统会提示当前有多少流水线引用了该策略,删除后相关流水线调度运行时会运行失败。 在策略列表页面,单击列表右侧,可以打开/关闭策略, 关闭策略时,如果策略有被引用,系统会提示当前有多少流水线引用了该策略,关闭后相关流水线调度运行时会忽略该策略中的准出条件。 在策略列表页面,单击页面右上方“租户策略”,打开“租户策略”侧滑框,可以查看、复制和继承租户级策略。 查看:单击操作列,可查看租户级策略,继续单击右上方“编辑”,可编辑租户级策略。 复制:单击操作列,可基于当前租户级策略复制一个项目级策略。 继承:单击操作列,可基于当前租户级策略继承一个项目级策略,通过继承生成的项目级策略,继承的规则实时和父租户级策略保持一致。。
共100000条