检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
专享版实例部署在虚拟私有云中,如果您的后端服务也部署在相同虚拟私有云,可直接通过私有地址访问,无需购买带宽。 专享版实例的API如从公网调用,实例需绑定一个弹性公网IP,作为公网入口。弹性公网IP需要单独购买。 专享版实例的API如仅在VPC内调用,无需购买/绑定弹性公网IP。
API网关对收到的调用请求不做身份认证,只需要按照API提供者提供的接口说明,封装规范的请求,发送给API网关即可。 API网关把请求内容透传给后端服务。
获取账号名和账号名ID 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下: 登录管理控制台。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 查看账号名和账号ID。 父主题: 附录
调用API。 使用接口测试工具配置API请求和认证信息。 选择请求方法“GET”,在“API运行”页面将URL地址复制到接口测试工具中,URL地址由https://调试域名/路径组成。 添加Header参数名称:X-Apig-AppCode,参数值填写已生成的AppCode。
MARKET模式,接口调用者必须是API购买者或拥有者。 CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。
它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言(Interface Definition Language,缩写IDL),同时底层的消息交换格式也是使用protobuf。
接口约束 使用策略授权用户时,需要包含apig:instanceTags:list、apig:instances:get的授权项才允许调用此接口 调用方法 请参见如何调用API。
接口约束 使用策略授权用户时,需要包含apig:instances:get、apig:instanceTags:create、apig:instanceTags:delete的授权项才允许调用此接口 调用方法 请参见如何调用API。
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。
max_latency 最大延迟毫秒数 统计测量api接口最大响应延时时间 ≥0 单位:毫秒 测量对象:专享版API网关实例 测量维度:instance_id 1分钟 req_count 接口调用次数 该指标用于统计测量api接口调用次数 ≥0 测量对象:单个API 测量维度:api_id
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。
接口约束 使用策略授权用户时,需要包含apig:instanceTags:list的授权项才允许调用此接口 调用方法 请参见如何调用API。
通过标签查询实例列表 功能介绍 通过标签查询实例列表 接口约束 使用策略授权用户时,需要包含apig:instance:listByTags的授权项才允许调用此接口. 调用方法 请参见如何调用API。
调用API示例 获取Token,并设置成环境变量,Token用于后续调用其他接口鉴权。
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。
创建API 操作场景 API提供者把API接口配置在API网关中,开放后端能力。 创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。
须知: 负载通道名称可修改时,当前实例的负载通道无法通过项目级负载通道管理接口操作。 app_jwt_enable app_jwt认证方式开关,默认关闭。启用后,可在API请求中添加如下参数,携带凭据的Key和Secret以及时间戳进行API的调用认证。
30 inner_time apig的内部处理时长,单位秒。 31 proxy_protocol_vni VPC终端节点的虚拟网络标识。 32 proxy_protocol_vpce_id VPC终端节点的ID。 33 proxy_protocol_addr 客户端源IP地址。