检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
选择API需要发布到的环境,并填写发布说明。 图1 发布API 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“发布”,完成API发布。 查看发布历史 单击“开放API > API管理”,进入到API管理信息页面。 单
API管理 对象模型 创建API 修改API 删除API 发布API 下线API 批量发布或下线API 查看API详情 查询API列表 查询API历史版本列表 根据版本编号下线API 查看版本详情 查询API运行时定义 调试API 父主题: 共享版API(仅存量用户使用)
导出API 导出JSON、YAML或YML格式的API。API网关支持单个API导出和批量API导出。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理
UrlDomain objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true 表10 UrlDomain 参数 参数类型 描述 id String 域名编号 domain
部署在VPC下的应用是否可以调用API? 默认部署在VPC下的应用可以调用API。如果域名解析失败,则参考配置内网DNS,在当前终端节点上配置DNS服务器。配置完成后,部署在VPC下的应用可以调用API。 配置内网DNS 配置DNS需要配置“/etc”目录下的resolv.conf文件,指定DNS服务器的IP地址。
服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample
API网关除了将传统的服务作为后端服务外,还可以将微服务集群作为后端服务进行开放。API网关后端对接CCE集群后,可以自动进行微服务发现,根据负载均衡策略将流量路由到微服务容器中,同时支持微服务的灰度发布。 函数工作流服务开放 API网关可以将无服务器服务(即函数工作流服务)作为后端
API调用是否支持长连接 支持。 注意适当使用长连接,避免占用太多资源。 父主题: API调用
String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表10 securityDefinitions 是 Object 定义鉴权方式,参考表14 x-ap
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? API发布到非RELEASE环境可以访问,添加x-stage请求消息头后即可访问。 例如: r.Header.Add("x-stage", "RELEASE") 您也可以参考快速开放并调用API章节中的示例。
API流量控制 是否支持对请求并发次数做自定义控制? 每个子域名(调试域名)每天最多可以访问1000次,如果账号为企业账号,是否还有这个限制? API调用是否存在带宽限制 流量控制策略不生效怎么办? 父主题: API控制策略
API网关共享版是否可以升级到专享版? 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案: 新购买专享版实例。 导出共享版中的API。 将API导入到专享版。 重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 父主题: 其他
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。本章节主要提供APP认证的SDK下载以及文档。 操作场景 API使用APP认证时,请根据需要下载SDK包和文档,参考文档完成API的调用。 操作步骤
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
请求Body参数 参数 是否必选 参数类型 描述 sl_domain_access_enabled 是 Boolean 设置调试域名是否可以访问,true为可以访问,false为禁止访问 缺省值:true 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
不使用VPC通道(负载通道)时,后端服务地址可以是什么? 可以是公网域名或者公网IP(支持云服务器的弹性IP地址)。前提需要开启公网出口, 可以是内网的IP,不可以是内网域名。 父主题: API创建
API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。 获取API的请求信息 在API网关控制台选择“开放API
图1 项目隔离模型 同样在“控制台 > 我的凭证”界面下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。
查看API绑定的ACL策略列表。 自定义认证管理 包括自定义认证的创建、修改、删除,查看自定义认证详情,查询自定义认证列表。 OpenAPI接口 包括API的导出、导入。 VPC通道管理 包括: VPC通道的创建、更新、删除、查看,查询VPC通道列表。 后端实例的添加、查看、删除。
组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来允许/拒绝某个IP地址或账户访问API。 应用(凭据) 应用(APP)定义了一个API调用者的身份。可以将一个API授权给多个应用,也可以将多个API授权给同一个应用。 签名密钥 签名密钥由