检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
OpenAPI接口 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 共享版API(仅存量用户使用)
后端服务调用报错域名无法解析“Backend domain name resolution failed” APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。 可能原因 APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。
要将其CNAME解析到API分组对应的子域名;对于专享版,您需要将其A记录解析到实例的入口地址。解析成功后,即可使用。域名与API分组为多对一的关系,即一个分组最多能绑定5个独立域名,但一个域名只能解析到1个分组。 如果您使用的公网域名,需要在DNS服务公网解析内注册CNAME记录(共享版)/A记录(专享版)。
部署在VPC下的应用是否可以调用API? 默认部署在VPC下的应用可以调用API。如果域名解析失败,则参考配置内网DNS,在当前终端节点上配置DNS服务器。配置完成后,部署在VPC下的应用可以调用API。 配置内网DNS 配置DNS需要配置“/etc”目录下的resolv.conf文件,指定DNS服务器的IP地址。
专享版-OpenAPI接口 导出API 导入API 父主题: 专享版API(V2)
API网关可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: API创建
操作流程 APIG专享版支持单向认证和双向认证两种认证方式,两种认证方式开启认证的流程相同,下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书
导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/i
API网关共享版是否可以升级到专享版? 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案: 新购买专享版实例。 导出共享版中的API。 将API导入到专享版。 重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 父主题: 其他
用户自定义的域名,需要增加A记录才能生效,具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{i
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi/apis?env_id
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instanc
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明
API调用 API调用失败的可能原因有哪些? API调用返回错误码如何处理? API调用报错“414 Request URI too large” "The API does not exist or has not been published in the environment
CR 是 cname_status Integer cname解析状态 1 未解析 2 解析中 3 解析成功 4 解析失败 R 否 ssl_id String 证书的编号 R 否 group_id String API分组的编号 CR 是 表2 证书对象模型 参数 类型 说明 操作类型
调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。 MARKET模式,接口调用者必须是API购买者或拥有者。 CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。
CR 是 cname_status Integer cname解析状态 1 未解析 2 解析中 3 解析成功 4 解析失败 R 否 ssl_id String 证书的编号 R 否 group_id String API分组的编号 CR 是 表2 证书对象模型 参数 类型 说明 操作类型
String 域名的编号 url_domain String 自定义域名 status Integer CNAME解析状态 1 未解析 2 解析中 3 解析成功 4 解析失败 响应消息样例: { "id": "c5e0d5ba62a34d26ad5c709ae22c1a17",