检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
是否支持移动应用调用API? API支持被移动应用调用。 使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。 父主题: 调用API
图解API网关
API、环境、凭据之间的关系? API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。 应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)key&secret。将指定的API授权给指定应用
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors:
req_count 接口调用次数 该指标用于统计测量api接口调用次数 ≥0 测量对象:单个API 测量维度:api_id 1分钟 req_count_2xx 2xx调用次数 该指标用于统计测量api接口调用2xx的次数 ≥0 测量对象:单个API 测量维度:api_id 1分钟 req_count_4xx
Long 满足条件的记录数 apis Array of PluginApiInfo objects 绑定插件的API列表。 表5 PluginApiInfo 参数 参数类型 描述 api_id String API编号 api_name String API名称。 支持汉字、英文、数
满足条件的记录数 apis Array of OrchestrationApiInfo objects 编排规则绑定的API列表。 表5 OrchestrationApiInfo 参数 参数类型 描述 api_id String API编号。 api_name String API名称。
API的响应码如何定义? API响应码分两种类型。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。
使用IAM认证调用API Token认证 AK/SK认证
查看应用绑定的API详情 操作场景 在应用绑定API后,查看应用绑定的API详情。 前提条件 已创建应用。 应用已绑定API。 操作步骤 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击待查看的API名称,进入API详情页面,查看API详情。
API可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
如果您需要限制API调用者在某个时间周期内的API调用次数,可以通过配置API认证凭据的配额控制来实现;如果您需要控制访问API的IP地址(API调用者的IP地址),可以通过配置API认证的凭据访问控制来实现。 调用API 通过获取API及API访问地址,调用API。根据API使用认证
查看APIG的带宽监控 API网关支持查看出入口带宽各项指标的监控数据,了解带宽的网络情况和使用率。 前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 查看带宽监控 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id}
通过CSE微服务导入API API网关支持导入微服务引擎(Cloud Service Engine,简称CSE)的微服务。将微服务作为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CSE微服务”,请联系客服。 目前仅广州友好、贵阳一、上海一、广州、北京四区域支持导入CSE服务。
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}
通过CCE工作负载导入API API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)的工作负载,将工作负载作为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE
x-apigateway-request-type: 'public' 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-request-type 是 String API类型,支持public和private。 public:公开类型API,可以上架。