API-华为云

数据加密服务 DEW-查询版本信息列表:响应示例

响应示例状态码： 200 请求已成功 { "versions" : [ { "min_version" : "", "links" : [ { "rel" : "self", "href" : "https://kms.region_id.domain.com/v1.0/" } ], "id" : "v1.0", "version" : "", "updated" : "2016-10-29T02:00:00Z", "status" : "CURRENT" } ] }

数据加密服务 DEW 查询密钥API版本信息

数据加密服务 DEW-查询版本信息列表:响应参数

响应参数状态码： 200 表1 响应Body参数参数参数类型描述 versions Array of ApiVersionDetail objects 描述version 相关对象的列表，详情请参见 versions字段数据结构说明。表2 ApiVersionDetail 参数参数类型描述 id String 版本ID（版本号），如“v1.0”。 links Array of ApiLink objects JSON对象，详情请参见links字段数据结构说明。 version String 若该版本API支持微版本，则填支持的最大微版本号，如果不支持微版本，则返回空字符串。 status String 版本状态，包含如下3种： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String 版本发布时间，要求用UTC时间表示。如v1.发布的时间2014-06-28T12:20:21Z。 min_version String 若该版本API 支持微版本，则填支持的最小微版本号，如果不支持微版本，则返回空字符串。表3 ApiLink 参数参数类型描述 href String API的URL地址。 rel String 默认值self。状态码： 500 表4 响应Body参数参数参数类型描述 error Object 错误信息返回体。表5 ErrorDetail 参数参数类型描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息状态码： 502 表6 响应Body参数参数参数类型描述 error Object 错误信息返回体。表7 ErrorDetail 参数参数类型描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息状态码： 504 表8 响应Body参数参数参数类型描述 error Object 错误信息返回体。表9 ErrorDetail 参数参数类型描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

数据加密服务 DEW 查询密钥API版本信息

数据加密服务 DEW-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在管理员创建 IAM 用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

数据加密服务 DEW 如何调用API

数据加密服务 DEW-构造请求:请求消息体

请求消息体请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

数据加密服务 DEW 如何调用API

数据加密服务 DEW-构造请求:请求URI

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

数据加密服务 DEW 如何调用API

数据加密服务 DEW-构造请求:请求消息头

请求消息头附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参见AK/SK认证。 X-Sdk-Date：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参见AK/SK认证。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID：账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。

数据加密服务 DEW 如何调用API

API网关 APIG-按需计费:适用计费项

适用计费项表1 按需计费适用计费项计费项说明版本（实例规格） API网关提供的实例版本有：基础版、专业版、企业版、铂金版等，您可以根据实际业务需要按需使用。实例版本说明，请参考产品规格。如果您当前使用的实例版本不能满足需要，API网关支持升级产品版本，例如从“基础版”升级到“专业版”或者铂金版，并且对现有业务没有影响。实例版本单价，请参考价格详情中的按需计费价格。公网带宽使用的公网入口和公网出口带宽大小。购买时长使用实例或公网带宽的时间长度，按小时计费，精确到秒。购买个数实例的个数。假设您计划使用1个专业版实例，开启公网出口，公网带宽大小为5Mbit/s，使用时长1小时，在价格计算器页面底部，您将看到所需的配置费用。图1 按需计费配置费用示例配置费用包括版本、公网带宽、实例数以及使用时长。

API网关 APIG

API网关 APIG-按需计费:计费周期

计费周期按需计费时，实例按秒计费，每一个小时整点结算一次费用（以GMT+08:00时间为准），结算完毕后进入新的计费周期。计费的起点以部署在API网关上实例启动运行的时间点为准，终点以实例删除的时间为准。例如，您在2023/03/10 8:45:30部署了专业版实例，然后在9:30:00将其全部删除，则计费周期分为如下两个时间段： 8:00:00~9:00:00时间段，在8:45:30~9:00:00间产生费用，该计费周期内的计费时长为870秒。 9:00:00~10:00:00时间段，在9:00:00~9:30:00间产生费用，该计费周期内的计费时长为1800秒。

API网关 APIG

API网关 APIG-按需计费:升级实例版本后对计费的影响

升级实例版本后对计费的影响如果您当前使用的实例版本不能满足需要，API网关支持升级产品版本，例如从“基础版”升级到“专业版”或者铂金版，并且对现有业务没有影响。如果您在一个小时内升级了实例版本，将会产生多条计费信息。每条计费信息的开始时间和结束时间对应不同配置在该小时内的生效时间。例如2023/03/10 9:00:00，您部署运行了专业版实例（假设实例版本单价为12.88元/小时/实例，公网带宽单价为0.063元/小时/实例）。并在9:30:00升级实例版本到企业版（假设实例版本单价为19.36元/小时/实例，公网带宽单价为0.063元/小时/实例），那么在9:00:00 ~ 10:00:00间会产生两条计费信息：第一条对应9:00:00 ~ 9:30:00，按照专业版计费。则参考计费项中的计费公式，该计费时间段内的费用为：1800÷3600x12.88x1+1800÷3600x0.063x1=6.47（元）。第二条对应9:30:00 ~ 10:00:00，按照企业版计费。则参考计费项中的计费公式，该计费时间段内的费用为：1800÷3600x19.36x1+1800÷3600x0.063x1=9.71（元）。

API网关 APIG

API网关 APIG-按需计费:计费示例

计费示例假设您在2023/03/10 8:45:30部署专业版实例（假设实例版本单价为12.88元/小时/实例，公网带宽单价为0.063元/小时/实例），然后在9:30:00将其全部删除，则计费周期分为如下两个时间段： 8:00:00~9:00:00时间段，在8:45:30~9:00:00间产生费用，该计费周期内的计费时长为870秒。则参考计费项中的计费公式，该计费时间段内的费用为：870÷3600x12.88x1+870÷3600x0.063x1=3.13（元）。 9:00:00~10:00:00时间段，在9:00:00~9:30:00间产生费用，该计费周期内的计费时长为1800秒。则参考计费项中的计费公式，该计费时间段的费用为：1800÷3600x12.88x1+1800÷3600x0.063x1=6.47（元）。

API网关 APIG

API网关 APIG-计费模式概述:共享版API网关

共享版API网关共享版API网关按调用量费用+公网流量费用计费，调用量指API调用次数，流量指API调用的下行网络流量。计费模式详情请参考表3。共享版APIG已下线，当前仅存量用户可以使用。关于计费模式详情请参考价格详情，下文不再具体描述。表3 共享版API网关计费模式计费模式按需计费付费方式后付费按照实际使用量计费。计费周期按天结算。账单出账时间通常在当前计费周期结束后一小时内，最长不超过三个小时。适用计费项使用量（包含API调用量和公网流量）如果后端服务与API网关不在同一区域，或后端服务不在华为云，将会额外收取API网关到后端服务的流量费用。适用场景适用于API需求较小的场景。

API网关 APIG 计费模式

API网关 APIG-什么是API网关:产品功能

产品功能 API生命周期管理包括API的创建、发布、下线和删除的完整生命周期管理功能。通过API生命周期管理功能，您可以快速、高效地开放成熟的业务能力。云原生网关 API网关将流量入口和微服务治理能力融合，用一个网关去同时支持了k8s Ingress和Gateway API的功能，不仅大幅提升了性能，还简化了架构，降低了部署和运维成本。便捷调试工具 API网关提供页面调试工具，您可以使用该工具添加HTTP头部参数与body体参数，对API进行调试，简化API开发，降低API的开发维护成本。版本管理 API可以发布到不同的环境，如果您需要再次发布此API到之前已发布的环境，那么此次的发布版本将立即覆盖之前的版本。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到任一API历史版本，以便满足业务灰度发布、版本升级、回滚等需求。环境变量环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。当API发布到不同环境时，发布过程中变量标识会被相应环境的变量值替换，API本身定义不变。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。精细流量控制针对不同的业务等级、用户等级，可实施API的请求频率、用户的请求频率、应用（凭据）的请求频率和源IP的请求频率的管控，用于保障后端服务的稳定运行。针对API调用path、query、header等参数精细化配置不同的流量的限制。流量控制的时间单位可以是秒、分钟、小时或天。针对特殊的应用（凭据）和租户设置特殊的流控限制。监控告警提供实时、可视化的API监控，包括：API请求次数、API调用延迟和API错误信息，通过监控面板更清晰地了解API的调用情况，识别可能影响业务的潜在风险。安全防护域名访问认证支持TLS1.1、TLS1.2防护，支持mTLS双向认证。访问控制策略主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。断路器策略是API网关在后端服务出现性能问题时保护系统的机制，支持通过熔断降级的方式保护后端服务。身份认证策略支持通过AKSK、Token等多种方式进行服务认证，支持用户通过函数自定义API访问认证逻辑，支持对后端服务进行证书校验，支持签名密钥用于后端服务验证API网关的身份。 VPC通道（负载通道）在API网关中创建VPC通道来访问VPC环境中的资源，并将部署在VPC中的后端服务开放为API。VPC通道具有负载均衡功能，可对接服务器、微服务注册中心，支持后端流量的均衡、灰度策略，从而实现后端服务的负载均衡。模拟响应 API网关支持设置模拟的API后端响应，支持利用Mock响应支持熔断降级、重定向等场景。 API云商店将华为云上创建的API通过华为云商店开放给合作伙伴及第三方开发者，从而实现业务能力变现。目前仅支持共享版API上架云商店。

API网关 APIG

API网关 APIG-产品规格差异:专享版与共享版的差异

专享版与共享版的差异 API网关当前提供共享版与专享版两种服务方式。其中共享版API即开即用，专享版API网关需要购买专享版实例，并在实例中管理API。专享版API网关常用于企业内部系统解耦，各服务部署在云上的VPC内，服务之间以RESTful API方式通信，通信链路在VPC内部进行，网络安全得到进一步保障。同时专享版实例支持前端或后端服务部署在公有网络，通过绑定弹性公网IP实现网络交互。表3 共享版与专享版API网关差异差异项共享版专享版计费按API的调用量和公网流量计费。按实例规格与公网出口带宽计费。网络访问公网访问。实例运行在虚拟私有云（VPC）中，在VPC内，使用实例的虚拟私有云访问地址调用API。可通过开启公网入口与出口访问，允许外部服务调用API，及后端部署在外部网络环境中。云商店售卖 API可在云商店公开售卖。不支持将API上架到云商店公开售卖。使用对象小型用户。物理隔离要求较低，能够开箱即用，快速实现API能力开放。中大型用户。专享版API网关拥有物理隔离的独立集群，更丰富的特性。满足内部API调用跟API开放，专享独立的公网带宽。 API网关的共享版与专享版在功能上的异同点如下表所示。表4 共享版与专享版API网关功能差异规格分类规格描述共享版专享版基本功能精细化流控 √ √ IP&用户访问控制 √ √ 安全认证 √ √ API生命周期管理 √ √ 自定义域名 √ √ Swagger导入导出 √ √ 支持VPC通道（负载通道） √ √ API参数编排 √ √ API分组变量管理 √ √ 高级功能自定义认证 √ √ 支持对接API云商店 √ 即将支持支持API策略路由 √ √ 运维分析展示 √ √ 支持后端负载均衡 × √ 支持内部API管理 × √ 后端支持对接私有云 × √ 支持对接专线服务 × √ 插件 × √ 日志分析 × √ 性能指标独立物理多租集群 × √ 出、入网带宽独立 × √ 推荐每秒请求次数 200TPS 4000~10000TPS

API网关 APIG

API网关 APIG-产品规格差异:专享版规格

专享版规格专享版API网关QPS（Query Per Second，每秒查询率）吞吐受应答大小、是否开启HTTPS、是否开启gzip等多种因素影响。下表是API网关处于30%CPU水位下的QPS参考值，参考场景为无认证和单机流控模式。安全水位指能够在突发流量增长至双倍的情况下，API网关系统依然维持高吞吐量和低延迟性能。表1 QPS性能参考实例规格基础版专业版企业版铂金版铂金版x2 连接类型应答字节数（KBytes）是否使用HTTPS 是否使用gzip CPU处于安全水位（30%）的QPS参考短连接 1 否否 3500 3600 9000 55000 72000 是否 1000 1100 2800 16000 20000 长连接 1 否否 4500 4200 13000 79000 105000 是否 4000 4000 11000 67000 95000 10 否否 3500 4000 10000 67000 85000 是否 3200 3800 9500 65000 80000 不同实例规格的带宽和内网连接数都不同，建议参考下表数据将带宽和连接数控制在有效范围内。表2 带宽和连接数参考实例规格带宽内网每秒新建连接数基础版单AZ：50Mbit/s 双AZ及以上：100Mbit/s 1000 专业版单AZ：100Mbit/s 双AZ及以上：200Mbit/s 1000 企业版单AZ：200Mbit/s 双AZ及以上：400Mbit/s 1000 铂金版单AZ：400Mbit/s 双AZ及以上：800Mbit/s 1000 铂金版 x2 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 铂金版 x3 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 铂金版 x4 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 铂金版 x5 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 铂金版 x6 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 铂金版 x7 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 铂金版 x8 单AZ：2Gbit/s 双AZ及以上：4Gbit/s 1000 部分新特性（支持实例规格变更、断路器策略等）在新版实例中才能使用，如果您发现当前实例不支持，请联系技术支持升级实例版本。专享版实例对于API的各项默认配额，与共享版一致。专享版实例规格变更请参考实例规格变更章节。目前仅北京四、上海一支持选择更多铂金版规格。

API网关 APIG

弹性云服务器 ECS-查询镜像列表（废弃）:URI

URI GET /v2.1/{project_id}/images?name={name}&status={status}&changes-since={changes-since}&minRam={minRam}&minDisk={inDisk} 参数说明请参见表1。表1 路径参数参数是否必选描述 project_id 是项目ID。获取方法请参见获取项目ID。支持分页查询。分页查询的相关信息，请参见分页查询。

弹性云服务器 ECS 镜像管理（OpenStack Nova API）

云服务器内容精选

API

7*24

备案

专业服务

退订

建议反馈

售前咨询热线