华为云用户手册

编译构建 CodeArts Build-计费模式概述:适用场景

适用场景包年/包月计费模式需要用户预先支付一定时长的费用，适用于长期、稳定的业务需求。以下是一些适用于包年/包月计费模式的业务场景：稳定业务需求：对于长期运行且资源需求相对稳定的业务，如企业官网、在线商城、博客等，包年/包月计费模式能提供较高的成本效益。长期项目：对于周期较长的项目，如科研项目、大型活动策划等，包年/包月计费模式可以确保在整个项目周期内资源的稳定使用。业务高峰预测：如果能预测到业务高峰期，如电商促销季、节假日等，可提前购买包年/包月资源以应对高峰期的需求，避免资源紧张。数据安全要求高：对于对数据安全性要求较高的业务，包年/包月计费模式可确保资源的持续使用，降低因资源欠费而导致的数据安全风险。

编译构建 CodeArts Build
编译构建 CodeArts Build-计费模式概述:计费周期

计费周期包年/包月CodeArts Build套餐的计费周期是根据您购买的时长来确定的（以UTC+8时间为准）。一个计费周期的起点是您开通或续费资源的时间（精确到秒），终点则是到期日的23:59:59。例如，如果您在2023/03/08 15:50:04购买了时长为一个月的CodeArts Build套餐，那么其计费周期为：2023/03/08 15:50:04 ~ 2023/04/08 23:59:59。

编译构建 CodeArts Build
编译构建 CodeArts Build-计费模式概述:计费示例

计费示例假设您在2023/03/08 15:50:04购买了包年/包月CodeArts Build套餐，购买时长为一个月，并在到期前手动续费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 您需要为每个计费周期预先付费，单价请参考编译构建服务价格详情。

编译构建 CodeArts Build
编译构建 CodeArts Build-计费模式概述:到期后影响

到期后影响图1描述了包年/包月CodeArts Build套餐各个阶段的状态。购买后，在计费周期内资源正常运行，此阶段为有效期；资源到期而未续费时，将陆续进入宽限期和保留期。图1 包年/包月CodeArts Build套餐生命周期到期预警包年/包月CodeArts Build套餐在到期前第15天内，系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为云账号的创建者。到期后影响当您的包年/包月CodeArts Build套餐到期未续费，首先会进入宽限期，资源状态变为“已过期”。宽限期内您可以正常使用编译构建服务。如果您在宽限期内仍未续费包年/包月CodeArts Build套餐，那么就会进入保留期，资源状态变为“已冻结”，您将无法对处于保留期的包年/包月资源执行任何操作。保留期到期后，若包年/包月CodeArts Build套餐仍未续费，那么将无法继续使用编译构建服务。华为云根据客户等级定义了不同客户的宽限期和保留期时长。关于续费的详细介绍请参见续费概述。

编译构建 CodeArts Build
编译构建 CodeArts Build-已开通旧版本编译构建服务，能否转换为新版本计费？

已开通旧版本编译构建服务，能否转换为新版本计费？本章节仅供老用户参考。已购买包周期套餐的用户，套餐到期后，您可以选择继续购买CodeArts Build包月套餐。开通旧版按需计费的用户，仍延续旧版按需计费规则，您也可以选择购买包月套餐，开始使用新版本计费。旧版套餐计费方式详情请参考CodeArts旧版计费方式说明，旧版编译构建服务关闭方式请参考关闭服务。开通/购买套餐需要您拥有租户账号，或拥有Tenant Administrator权限的 IAM 用户账号，配置权限策略方法请参考创建用户组并授权。父主题：计费FAQ

编译构建 CodeArts Build
编译构建 CodeArts Build-资源扩展:场景1

场景1 在编译构建服务中，构建任务是构建的最小单元，对于以下构建场景，构建任务可能并不能满足构建要求。例如：多仓工程需要分布到多个机器上去构建，并且构建工程之间还存在一定的依赖关系。希望更模块化、更加细粒度地拆分构建任务，并按照依赖顺序进行构建。对于上述构建场景，编译构建服务支持使用BuildFlow将多个存在依赖关系的构建任务按照有向无环图（DAG）的方式组装起来，BuildFlow将会按照构建的依赖关系并发进行构建。此场景下，需要编译构建多任务并发执行。构建并发数计算方式示例如下：构建任务A中包括4个子任务，启动构建任务A，此时任务并发数为4。父任务（构建任务A）不会占用一个并发。构建并发包为租户级别，一个并发包资源同时只能由一个构建任务使用。

编译构建 CodeArts Build
编译构建 CodeArts Build-续费概述:续费相关的功能

续费相关的功能包年/包月CodeArts Build套餐续费相关的功能如表1所示。表1 续费相关的功能功能说明手动续费包年/包月编译构建服务从购买到到期无法使用之前，您可以随时在编译构建服务控制台为CodeArts Build套餐续费，以延长编译构建服务的使用时间。自动续费开通自动续费后，CodeArts Build套餐会在每次到期前自动续费，避免因忘记手动续费而导致服务无法使用。在包年/包月CodeArts Build套餐生命周期的不同阶段，您可以根据需要选择一种方式进行续费，具体如图1所示。图1 CodeArts Build套餐生命周期编译构建服务从购买到期前，处于正常运行阶段，套餐状态为“运行中”。到期后，套餐状态变为“已过期”。到期未续费时，编译构建服务首先会进入宽限期，宽限期到期后仍未续费，套餐状态变为“保留”。超过宽限期仍未续费将进入保留期，如果保留期内仍未续费，资源将被自动删除。华为云根据客户等级定义了不同客户的宽限期和保留期时长。在CodeArts Build套餐到期前均可开通自动续费，到期前7日凌晨3:00首次尝试自动续费，如果扣款失败，每天凌晨3:00尝试一次，直至CodeArts Build套餐到期或者续费成功。到期前7日自动续费扣款是系统默认配置，您也可以根据需要修改此扣款日。

编译构建 CodeArts Build
编译构建 CodeArts Build-增值特性

增值特性编译构建服务提供了构建加速包增值特性。构建加速服务通过解析构建工程的内部依赖关系，将构建任务拆解分发至多个执行机并发执行，结合增量编译技术，实现对软件编译过程的效率提升，支撑企业研发过程的快速迭代，缩短产品的上市周期。表1 构建加速包计费方式包年/包月适用场景编译构建服务提供了构建加速能力，使用构建加速能力前需购买构建加速包。构建加速场景请参考构建加速。构建加速包只支持执行主机为“内置执行机”的构建任务，可选择x86或arm。构建主机配置方法请参考构建环境配置。构建加速包提供三种加速级别，请根据需要选择。 L1级别：对于C/C++的工程，典型的编译过程是CPU消耗型任务，编译效率受限于编译并发度，编译并发度受限于单机资源规格，传统的单机构建模式很难突破资源规格的瓶颈。L1级别通过分布式编译技术，将单机编译任务分发到后台算力资源上进行编译，支持远超单机资源核数的并发数，突破单机资源规格的限制，从而实现提升编译效率的目标。 L2级别：对于大多数开发过程，构建之间只有少量代码变更，除去更新的部分外，其余的代码编译均为重复构建。L2级别通过增量构建提升编译效率，在编译过程中对编译结果进行缓存，下次编译时通过对源码的变更来判断是否可以命中缓存，通过缓存大幅减少重复编译任务的执行，从而实现提升编译效率的目标。 L3级别：L3级别同时提供分布式编译和增量编译的能力，对于没有变化的代码提供增量编译，对于变化的代码提供分布式编译，最大限度地提升构建效率。说明：构建加速LI级别/L2级别/L3级别均包含64vCPU算力。购买限制购买构建加速包前，须完成CodeArts基础版及以上规格套餐或CodeArts Build套餐的购买。构建加速包的单次购买上限为16个。计费公式单价*数量*购买时长计费周期根据购买时长确定（以UTC+8时间为准）。一个计费周期的起点是您开通或续费构建加速包的时间（精确到秒），终点则是到期日的23:59:59。例如，如果您在2023/03/08 15:50:04购买时长为一个月的构建加速包，那么其计费周期为：2023/03/08 15:50:04 ~ 2023/04/08 23:59:59。变更配置构建加速包不支持变更配置。若完成购买后发现配置有误，需退订后重新购买。到期后影响构建加速包到期未续费时，该构建加速包中包含的并发数将失效。父主题：计费模式

编译构建 CodeArts Build
编译构建 CodeArts Build-停止计费:包年/包月资源

包年/包月资源对于包年/包月计费模式的资源，例如包年/包月的CodeArts Build套餐、包年/包月的云硬盘等，用户在购买时会一次性付费，服务将在到期后自动停止使用。如果在计费周期内不再使用包年/包月编译构建服务，您可以执行退订操作。CodeArts Build套餐、资源扩展、增值特性均支持退订。系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。如果您已开启“自动续费”功能，为避免继续产生费用，请在自动续费扣款日（默认为到期前7日）之前关闭自动续费。

编译构建 CodeArts Build
编译构建 CodeArts Build-计费项:计费示例

计费示例以包年/包月计费模式为例，假设您在2023/03/08 15:50:04购买了CodeArts Build套餐，购买时长为一个月，并在到期前手动续费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 CodeArts Build套餐专业版每月前1800分钟免费，单租户1个内置执行机(2U8G)并发和1个自定义执行机并发，使用限制性资源池，超过并发数时构建任务会进行排队。免费时长后的具体价格请以编译构建服务价格详情中的价格为准。用户可通过购买资源扩展扩容并发数，购买的构建并发包不限制构建时长。

编译构建 CodeArts Build
API中心 API Hub-修订记录

修订记录发布日期修订记录 2023-09-27 第八次正式发布。新增如下章节：附录-API治理规范指导 2023-07-14 第七次正式发布。优化如下章节：约束与限制 2023-05-22 第六次正式发布。新增如下章节：图解API中心优化如下章节：产品优势 2023-03-31 第五次正式发布。优化如下章节：什么是API中心应用场景产品功能与其他服务的关系 2023-03-22 第四次正式发布。优化如下章节：产品功能 2023-03-03 第三次正式发布。优化如下章节：产品功能 2023-02-10 第二次正式发布。优化如下章节：约束与限制 2022-12-14 第一次正式发布。

API中心 API Hub
API中心 API Hub-可维护性:保证API日志采集的实时性及完整性

保证API日志采集的实时性及完整性本条规则是MUST类型的基本规则，可保障API的可维护性。在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。在对API日志处理过程中，仅能对API日志进行增维操作，禁止对API日志中重要部分，如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。

API中心 API Hub
API中心 API Hub-基本概念:签名密钥

签名密钥签名密钥由一对Key和Secret组成，用于后端服务验证API网关代理的身份，在API网关代理请求后端服务时，保障后端服务的安全。当签名密钥绑定API后，API网关代理向后端服务发送此API的请求时，会增加相应的签名信息，此时，后端服务依照同样方式进行签名并得到签名结果，如果签名结果和API网关代理传过来的Authorization头中的签名一致，则可证明API请求确实来自API网关代理，而不是其他伪造请求。

API中心 API Hub
API中心 API Hub-服务韧性

服务韧性 API中心提供了4级可靠性架构，通过全局部件跨Region容灾、Region部件跨AZ容灾、AZ内集群容灾、数据库主备容灾，保障服务的持久性与可靠性。表1 API中心可靠性架构可靠性方案简要说明跨Region容灾全局级部件支持跨Region容灾，当主Region异常后，全局业务可以切换到备Region继续运行。双AZ容灾 Region级部件实现跨AZ双活，一个AZ异常时不影响云服务持续提供服务。 AZ内集群容灾通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。数据容灾数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。父主题：安全

API中心 API Hub
API中心 API Hub-产品功能

产品功能表1 API中心功能概览功能名称功能描述发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具（如华为云API Arts），进行API的设计、测试等。华北-北京四服务商入驻 API开发者可在线申请入驻成为API中心的服务商。华北-北京四 API资产管理 API中心服务商可在API中心管理控制台管理API资产。华北-北京四 API网关代理 API中心服务商可使用API中心的网关代理模块，进行API注册、发布，并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。华北-北京四 API门户 API中心门户汇聚展示千行百业API，为应用开发者提供统一的API搜索查找入口，并通过智能搜索和推荐，帮助开发者快速找到所需API。华北-北京四在线调测应用开发者可在API门户的API详情页进行API在线调测，快速试用API。说明： API是否支持调测，取决于伙伴服务商上架API资产时是否提供了相关试用调测环境。部分API暂未提供调测能力。具体功能以API详情页面展示的为准。华北-北京四 API凭证获取对于技术开放型API，应用开发者可根据API使用指南中的指定方式或者联系 API服务商获取API调用凭证。对于商业售卖型API，应用开发者可根据页面引导前往云商店通过购买获得API调用凭证。华北-北京四

API中心 API Hub
API中心 API Hub-安全性:涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制

涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：密码、AK/SK、Token等身份凭据。密钥。个人信息，如身份证号码、银行卡信息、家庭住址、健康信息等。人与人之间的私人消息，如短信、电话通信内容。

API中心 API Hub
API中心 API Hub-简介:目的

目的主要用于指导伙伴、开发者在华为云API中心生产和开放API。通过统一的API治理框架和规范，帮助伙伴、开发者构建并提供有质量保障的API服务，为平台营造良好能力开放与交互的环境，支撑华为云和伙伴及开发者共建API生态。 API治理规范主要从安全、可用性、易用性、可维护性，生命周期管理六个维度针对API生产（API设计/开发/测试）和API开放提供规则建议。安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。可维护性：对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议，提升API可维护性。生命周期管理：对API变更和下线等提出规范要求或建议，保障已订阅API租户的业务连续性。包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。

API中心 API Hub
API中心 API Hub-可用性:API请求URI中如果存在特殊字符，需要进行转义编码

API请求URI中如果存在特殊字符，需要进行转义编码本条规则是MUST类型的基本规则，可保障API的高可用性。某些字符，由于有特殊含义或者系统保留，容易被 Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。转义说明可参考：RFC 2396（Uniform Resource Identifiers (URI): Generic Syntax）。

API中心 API Hub
API中心 API Hub-可用性:API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致

API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致本条规则是MUST类型的基本规则，可保障API的高可用性。在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。 API响应内容格式需要与响应设置媒体类型和编码格式一致。在API响应中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。 API的默认媒体类型为“Content-Type: application/json”和“charset=UTF-8”。当使用非application/json媒体类型时，建议根据情况选择合适的媒体格式，具体情况如表2所示。表2 常见的媒体类型分类场景媒体类型文件上传/下载类文件上传下载类的接口，直接传递的是文件内容。须知：不建议使用该API进行文件传输。 application/octet-stream 表单提交主要用于界面表单提交，该方法目前已经不属于主流提交手段，建议使用JSON格式进行表单提交。 application/x-www-form-urlencoded 混合多部分类型传递混合多部分内容类的接口，比如既有文本内容，表单内容，也有二进制文件的。 multipart/form-data SOAP协议调用以SOAP协议的WebService。 text/xml或application/xml 纯文本类型仅传递纯文本内容。 text/plain

API中心 API Hub
API中心 API Hub-可用性:API响应状态码应使用规范的HTTP状态码

API响应状态码应使用规范的HTTP状态码本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。具体的HTTP状态码使用可参考RFC 7231（Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content），常用状态码如表1所示。表1 常用状态码状态码状态码表示状态码详细信息 200 OK 执行成功，如：查询成功响应。 201 Created 创建成功，如：创建记录成功。 400 Bad Request 客户端请求语义有误，当前请求无法被服务器理解或请求参数有误。 401 Unauthorized 当前请求需要用户验证，需要用户提供Token进行认证。 403 Forbidden 禁止访问某些资源，如权限不足时无法查询对应的信息。 404 Not Found 无法找到对应资源，如资源不存在。 405 Method Not Allowed HTTP方法不能被用于请求相应的资源如：HTTP方法要求POST方法，请求中使用了GET方法。 406 Not Acceptable 请求资源的内容特性无法满足请求头中的条件。 413 Payload Too Large 请求提交的实体数据大小超过了服务器够处理的范围。 414 URI Too Long 请求的URI长度超过了服务器能够解释的长度。 415 Unsupported Media Type 当前请求的方法和所请求的资源，请求中提交的实体并不是服务器中所支持的格式。 500 Internal Server Error 服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。通常是服务器内部产生了错误，导致处理失败。 502 Bad Gateway 代理服务器尝试执行请求时，从上游服务器接收到无效的响应。

API中心 API Hub
API中心 API Hub-易用性:API文档按照模板进行写作

API文档按照模板进行写作本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API对外开放时，API文档建议使用统一的模板，以便保持API参考文档的一致性，易于开发者理解。在API参考文档中必须包含如下内容： API目录，包括本次提供API的列表信息。 API名称及API功能介绍。 API请求方法和URI。 API请求参数说明，包括Header、Query参数，需要明确字段内容和取值范围。 API请求Body内容，Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码，状态码及对应的说明。 API响应参数说明包括Header参数，需要明确字段内容和取值范围。 API正常响应Body内容，正常响应Body内容需要明确响应结构体内容及各个字段的取值范围。 API异常响应Body内容，异常响应Body中描述及说明。

API中心 API Hub
API中心 API Hub-易用性:API名称必须易于理解、见名知义

API名称必须易于理解、见名知义本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义，建议按照“动词+名词”格式。在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、数字以及“_”或者"-"，API名称长度建议不超过150字符。例如：易于理解的API名称应为“查询虚拟机列表”/“ListServers”、“创建VPC网络”/“CreateVPC”

API中心 API Hub
API中心 API Hub-责任共担

责任共担华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。安全性是华为云与您的共同责任，如图1所示。华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。租户：负责云服务内部的安全，安全地使用云。华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。图1 华为云安全责任共担模型父主题：安全

API中心 API Hub
API中心 API Hub-安全性:API使用合适的认证模式

API使用合适的认证模式本条规则是Should类型的扩展规则，可提升API的安全性。根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。表1 认证模式说明认证模式认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey用于进行身份认证，该认证方法直接传递密钥，在使用过程中需要使用HTTPS协议保证传输安全。签名认证请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证，该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256进行计算，在API请求过程中不会直接传递SignKey，同时对请求时间进行有效校验，避免重复请求攻击。动态Token API请求可使用AppId及AppKey向Token服务器换取动态Token，在动态Token有效期内，在API请求Header中携带Token进行身份认证，由于在换取Token过程中传递AppKey，因此换取Token需要使用HTTPS协议保证传输安全。

API中心 API Hub
API中心 API Hub-应用场景:API商业变现

API商业变现当前面临的主要问题 API商业变现方式不够灵活。缺少多维度的数据分析支撑。 API中心解决方案 API中心协同华为云云商店为API构建灵活多样的商业闭环路径，并提供API调用次数、API调用者等数据分析能力。直接变现：API开发者完成API设计/开发/测试后，可以将API注册在华为云生态网关，然后在华为云云商店上架API商品并定价售卖，实现直接售卖API并获得商业收益。间接变现：API能力开放给应用开发者，供其在应用开发和集成中调用。应用生产出来后，可在华为云云商店上架SaaS等应用类型商品，实现API的间接变现，获得商业收益。

API中心 API Hub
API中心 API Hub-易用性:API响应报文使用分页，避免超长列表数据返回

API响应报文使用分页，避免超长列表数据返回本条规则是Should类型的扩展规则，可提升API调用者的使用体验。获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit)，位移量(offset)。查询资源列表需要返回符合查询条件的资源总数(count)、查询数量(limit)、位移量(offset)。举例：查询虚拟机从第10条开始，查询后100条。请求 GET /ecs/v1/projects/xxxxx/servers?offset=10&limit=100 响应 {"resources":[ { "id":"xxx",},… { "id":"xxx", }], "offset":10, "limit":100, "count":1540}

API中心 API Hub
API中心 API Hub-易用性:API描述信息必须易于理解，表述准确

API描述信息必须易于理解，表述准确本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API描述信息要易于理解，字面表述准确，能说明API的用途，场景及约束。 API描述信息建议使用Markdown格式编写，便于生成对应API文档，API描述信息长度建议不超过2000字符。例如：发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表，列表包括虚拟机名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。”

API中心 API Hub
API中心 API Hub-术语:REST

REST REST（Representational State Transfer，表征状态转移）网络上的所有事物都可被抽象为资源，每一个资源都有唯一的资源标识（resource identifier），对资源的操作不会改变这些标识，所有的操作都是无状态的，使用标准方法操作资源。 RESTful风格的服务接口需定义：操作名、URL、请求和响应消息体和响应状态码。本文后续章节将分别描述接口各部分的定义规范。

API中心 API Hub
API中心 API Hub-约束与限制

约束与限制 API中心的使用限制如下：创建API资产：每个用户最多可以创建50个API资产。 API网关代理：API网关代理使用限制如表1所示。表1 API网关代理使用限制限制项限制值 API分组数量每个用户最多可以创建50个API分组。独立域名数量每个分组最多可以绑定5个独立域名。 API数量每个用户最多可以创建200个API。后端策略数量每个API最多可以创建5个后端策略（不包含默认后端策略）。凭据数量每个用户最多可以创建50个凭据。流量控制策略数量每个用户最多可以创建15个流量控制策略。签名密钥策略数量每个用户最多可以创建5个签名密钥。访问控制策略数量每个用户最多可以创建5个访问控制策略。环境数量每个用户最多可以创建5个环境（包含默认的RELEASE环境）。环境变量数量每个分组在任意一个环境中，最多可以创建50个环境变量。负载通道数量每个用户最多可以创建10个VPC通道，每个负载通道最多可以添加10个服务器。参数数量每个API最多可以创建50个参数。发布历史数量同一个API在每个环境中最多记录10条最新的发布历史。每个API的访问频率不大于200次/秒。特殊应用每个流控策略最多可以创建30个特殊应用。特殊租户每个流控策略最多可以创建30个特殊租户。子域名访问次数每个子域名每天最多可以访问1000次。调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议支持TLS1.1和TLS1.2，推荐使用TLS1.2。本章描述的“用户”指的都是华为云账号。如果API网关代理当前的配额限制无法满足您的需求，您可以向系统提交工单申请更多配额。

API中心 API Hub
API中心 API Hub-可维护性:API请求HTTP动词使用标准化且满足幂等性

API请求HTTP动词使用标准化且满足幂等性本条规则是Should类型的扩展规则，可提升API的可维护性。 HTTP方法的需要符合幂等性的约束，幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用，单个资源操作，资源的标准CRUD操作对应的HTTP动词如表1所示。表1 HTTP动词方法描述幂等性 POST 适用于新建资源场景，以及CRUD无法表达的操作场景（Non-CRUD）。否 GET 用于获取资源的场景，必须具备安全性。是 PUT 如果操作的URL为一个新资源，则创建该资源。如果URL为一个已存在的资源，则替换该资源，传入的消息体需包含被替换资源的完整信息。如果传递的信息不完整，在服务实现端需提供对应信息的默认值。是 DELETE 用于删除资源的场景。是 HEAD 返回资源的元信息比如：ETag和Last-Modified之类的信息。是 PATCH 用于部分更新资源的场景，如果使用PUT操作所需输入的整体资源信息内容大小与PATCH操作无太大差异，优先使用PUT操作，不推荐使用PATCH操作。是 OPTIONS 获取当前资源支持哪些方法的信息。是例如：使用正确的HTTP动词。 “查询虚拟机列表”：GET /servers “创建VPC网络”：POST /vpc “删除虚拟机标签”：DELETE /server/tag “创建/更新数据库实例元数据”：PUT /instance/metadata

API中心 API Hub API生产

共99354条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线