检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身,也包括运维运营安全,以及更广义的安全合规遵从。 租户:负责云服务内部的安全,安全地使用云。 华为云租户的安全责任在于对使用的IaaS、PaaS和Sa
域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项
API订阅管理 您可以在API中心门户网站中,通过订阅API,获取API资产服务商的联系方式。如果您想要查看您在API中心门户网站中已经订阅的所有API,或对已经订阅的API单个或批量取消订阅,可以参考本章指导操作。 查看已经订阅的所有API:参考查看订阅的所有API。 对已经订
API资产管理 通过创建API资产,将您开发好的API分享至API中心门户网站,其他开发者就可以在API中心门户网站搜索到您分享的API,用于自己的项目开发。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 1个服务商最多可以创建50个API资产。 1
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正
可以充分发挥开发者的创造性,增加企业业务覆盖面和访问流量,是企业新的商业模式和收入来源。 读者对象 API构建者包括:架构师、开发、测试、运维、产品经理、CTO等。 父主题: 概述
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
重置Secret Key唯一且不可重置,Secret支持重置。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。
为简易认证绑定AppCode 简易认证指调用API时,在HTTPS请求头部消息增加一个参数“X-Apig-AppCode”(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
服务商入驻 API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代理包括API的
为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代
约束与限制 API中心的使用限制如下: 创建API资产:每个用户最多可以创建50个API资产。 API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。