检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用API 调用APIG开放的API 跨域调用APIG开放的API APIG的API响应消息头说明 APIG的API错误码说明
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。 API网关控制台中已经限定您无法创建HEADER位置的x-auth-token
y and Access Management,简称IAM),通过IAM,您可以: 根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用API网关服务资源。 根据企业用户的职能,设置不同的访问权限,以达到用户之间的权限隔离。
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
全组不生效,如需禁用部分IP请使用访问控制策略。 步骤一:准备工作 注册华为云并实名认证。 如果您已有一个华为账号,请跳过此步骤。如果您还没有华为账户,请参考注册华为账号并开通华为云和实名认证介绍,完成华为云的注册和实名认证。 在创建APIG实例前,确保账户有足够金额。 如果您需要为账户充值,请参考账户充值。
的控制华为云资源的访问。 通过IAM,您可以在华为云账号中给员工创建IAM用户,并使用策略来控制员工对API网关资源的访问范围。 如果华为云账号已经能满足您的需求,不需要创建独立的IAM用户进行权限管理,您可以跳过本章节,不影响您使用API网关服务的其它功能。 IAM是华为云提供
在传统流量控制策略的基础上提供了插件流量控制2.0策略,通过制定更加精细的方案来进行流控。 以下将以流量控制2.0为例,进行实践说明,讲述如何通过创建流量控制2.0策略来应对不同场景的网关限流。 方案优势 流量控制2.0策略可以限制单位时间内API的被调用次数,支持基础流控、参数流控和基于基础流控的特殊流控。
结算失败,账号将变成欠费状态,华为云将通过邮件、短信和站内信的方式通知您。 欠费后,按需实例不会立即停止服务,资源进入宽限期。您需支付按需实例在宽限期内产生的费用,相关费用可在华为云控制台的“费用 > 费用账单 > 总览”页面的“欠费金额”查看,华为云将在您充值时自动扣取欠费金额。
购买云专线。 购买一条连接本地数据中心到华为云API网关(所绑定的虚拟私有云)的云专线,请按以下操作顺序执行: 购买物理连接接入 即购买一条连接本地数据中心与华为云的运营商线路。建议您选择“一站式接入”,华为云负责施工工程。 如果已有数据中心到华为云的物理连接,可直接使用。 创建虚拟网关
构造请求 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
"error_code": "APIG.1000" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用API
证为例,介绍如何使用函数服务实现自定义认证。 操作流程 编写自定义认证函数 创建一个函数作为用户自己的认证服务。 创建自定义认证 在APIG中创建一个自定义认证,将函数服务接入APIG。 创建自定义认证的API 创建一个自定义认证方式的API。 设置错误响应 为了让API响应结果
X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 父主题: 如何调用API
API的响应码如何定义? API响应码分两种类型。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
调试API的时候,如何指定环境? 调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。 调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
/a/{b+}。 端口 填写CCE工作负载的监测端口号。 安全认证 支持APP认证、华为IAM认证和无认证。 APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示借助IAM服务进行安全认证。 无认证:表示不需要认证。 支持跨域CORS
结算失败,账号将变成欠费状态,华为云将通过邮件、短信和站内信的方式通知您。 欠费后,按需实例不会立即停止服务,资源进入宽限期。您需支付按需实例在宽限期内产生的费用,相关费用可在华为云控制台的“费用 > 费用账单 > 总览”页面的“欠费金额”查看,华为云将在您充值时自动扣取欠费金额。