检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型:传统的
对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
e8c","7addcd00cfab433984b1d8bf2fe08aaa"] } 响应消息 表4 参数说明 名称 类型 说明 success_count Number 成功解除绑定的ACL策略数量 failure Array 解除绑定失败的ACL策略及错误信息 表5 failure参数说明
CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 stage 否 String 调试请求指定的运行环境,仅在mode为CONSUMER时有效,未提供时有如下默认值:
String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略值,支持一个或多个值,使用英文半角逗号分隔 请求消息样例: { "acl_name": "string", "acl_type": "PERMIT", "acl_value":
云审计控制台对用户的操作事件日志保留7天,过期自动删除,不支持人工删除。 本节介绍如何在云审计服务管理控制台查看或导出最近7天的操作记录: 在新版事件列表查看审计事件 在旧版事件列表查看审计事件 使用限制 单账号跟踪的事件可以通过云审计控制台查询。多账号的事件只能在账号自己的事件列
右侧返回结果回显区域打印API调用的Response信息。 开发者可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 父主题: 共享版操作指导(仅存量用户使用)
创建gRPC类型的API,前后端协议均为GRPCS。 发布API 将gRPC类型的API发布到环境上。 验证 使用gRPC客户端测试gRPC服务可用性,如果服务端正常返回响应,则表示gRPC服务可用。 父主题: 使用APIG专享版实现gRPC服务的路由转发
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
tcp http CRU 是 path Integer 路径,仅当协议为http时生效 CRU 否 port Integer 端口,无值时,使用通道端口 CRU 否 threshold_normal Integer 正常阈值 CRU 是 threshold_abnormal Integer
删除分组指定错误类型的自定义响应配置 功能介绍 删除分组指定错误类型的自定义响应配置,还原为使用默认值的配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id
批量添加或删除单个实例的标签。 接口约束 使用策略授权用户时,需要包含apig:instances:get、apig:instanceTags:create、apig:instanceTags:delete的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI POST /v
使用APIG专享版实现http到https自动重定向 方案概述 操作流程 实施步骤 父主题: 开放API
查看签名密钥未绑定的API列表 绑定签名密钥 查看签名密钥绑定的API列表 查看API绑定的签名密钥列表 解除绑定 父主题: 共享版API(仅存量用户使用)
PI缺少公网访问的有效地址,公网调用API失败。 绑定EIP后重新调用即可,详细步骤请参考网络环境准备。 入方向规则配置有误,导致公网调用API失败。 配置入方向规则的详细步骤请参考网络环境准备。 调用时未添加请求消息头“host:分组域名”,导致公网调用API失败。添加消息头后,重新调用即可。
是否必选 类型 说明 id 是 String VPC通道的编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 vpc_instances 是 字典数据类型 后端实例列表。 表4 后端实例详情 参数 是否必选 类型 说明 instance_name 是 String 云服务器的名称。
使用APIG专享版实现不同后端服务的调用 方案概述 操作流程 实施步骤 父主题: 开放API
调用已发布的API 调用API 响应消息头 错误码 父主题: 共享版操作指导(仅存量用户使用)