检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过校验AppCode来实现对API的调用。 步骤一:准备工作 注册华为云并实名认证。 如果您已有一个华为账号,请跳过此步骤。如果您还没有华为账户,请参考注册华为账号并开通华为云和实名认证介绍,完成华为云的注册和实名认证。 在创建APIG实例前,确保账户有足够金额。 如果您需要为账户充值,请参考账户充值。
后端自定义认证对象的ID url_domain String 策略后端的Endpoint。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。 支持环境
UrlDomainsResp objects 分组上绑定的独立域名列表 表5 UrlDomainsResp 名称 类型 说明 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态: 1:未解析 2:解析中 3:解析成功
后端自定义认证对象的ID url_domain String 后端服务的地址。 由主机(IP或域名)和端口号组成,总长度不超过255。格式为主机:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443,HTTP默认端口号为80。 支持环境变量,使用环境变量时,每个变量名的长度为3
包括签名密钥的创建、修改、删除和查询接口。 签名密钥绑定关系管理 包括签名密钥的绑定和解除绑定接口,查询签名密钥绑定/未绑定API列表接口。 域名管理 包括域名的绑定、解绑和证书的绑定、删除接口。 VPC通道管理 包括创建VPC通道、更新VPC通道、删除VPC通道、查看VPC通道详情和列表、添加和删除云服务器、查看云服务器列表。
参数名不能是x-stage,不区分大小写。 参数位置为HEADER时,参数名不区分大小写,也不支持下划线开头。 如上图,test01和test03在调用API时分别配置于PATH和QUERY位置,后端服务通过映射,将在HEADER位置接收test01和test03的值。test02在
字典数据类型 分组上绑定的独立域名列表 on_sell_status Integer 是否已上架云商店: 1:已上架 2:未上架 3:审核中 表4 url_domains参数说明 名称 类型 说明 id String 域名编号 domain String 访问域名 cname_status
后端自定义认证对象的ID url_domain String 策略后端的Endpoint。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。 支持环境
API所属的分组。选择已有的分组,如果需要新建分组,单击“新建分组”即可创建。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:默认为POST。 请求协议:默认为GRPCS.。 子域名:所在分组的调试域名。 路径:需要根据实际业务从以下三种配置方式中选择配置。 / /{包名}.{服务名} /{包名}
在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名信息是否一致。 使用HTTPS对请求进行加密。 需要确保已有相应的SSL证书。 使用后端认证。 您可以对后端服务开启安全认证,只受理携带正确授权信息的API请求。在创建API的定义后端服务阶段,可以开启后端认证。
2:非默认分组 表5 url_domains参数说明 名称 类型 说明 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态: 1:未解析 2:解析中 3:解析成功 4:解析失败 ssl_id String
environment. 404 API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The API
3-64个字符,可以为空,不能以x-apig、x-sdk开头,不区分大小写,不能是x-stage、authorization,不区分大小写 backend_sign_header 签名密钥策略(BASIC、AUTH和HMAC)传到后端的签名信息的头域可以由此处的配置项承载。 -
不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写 不支持取值为"X-Stage",不区分大小写 mode为MARKET或CONSUMER时,不支持取值为"X-Auth-Token"和"Authorization",不区分大小写 说明: 头域名称在使用前会被规范化,如:"x-MY-
version 版本 未使用 用户指定 未指定则使用当前时间 host server.url API分组域名 未使用 优先使用API分组的第一个自定义域名 如果分组未绑定自定义域名则使用分组的独立域名 basePath - - 将与每条API的请求路径拼接起来使用 未填充 paths.path
不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写 不支持取值为"X-Stage",不区分大小写 mode为MARKET或CONSUMER时,不支持取值为"X-Auth-Token"和"Authorization",不区分大小写 说明: 头域名称在使用前会被规范化,如:"x-MY-
不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写 不支持取值为"X-Stage",不区分大小写 mode为MARKET或CONSUMER时,不支持取值为"X-Auth-Token"和"Authorization",不区分大小写 说明: 头域名称在使用前会被规范化,如:"x-MY-
速识别和查找。例如“API01”。 所属分组 默认“DEFAULT”。 URL 请求方法:接口调用方式,此处选择“GET”。 请求协议:选择API请求协议,默认“HTTPS”,对应wss协议。 子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。
以下原因可能导致后端服务调用失败或者超时,请逐一排查。 原因 解决方案 后端服务地址错误。 在编辑API中修改后端服务地址。 如果是域名,请确认域名能正确解析到后端服务IP地址。 后端超时时间设置不合理。 当后端服务没有在设置的后端超时时间内返回时,API网关提示后端服务调用失败。
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时,请根据需要下