检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
终端节点服务名称 填写终端节点服务名称。购买实例后,同步创建VPC终端节点服务,可以被终端节点连接和访问。 如果填写了终端节点服务名称,购买实例后,在实例详情中的“终端节点管理”页签下展示名称为{region}.{终端节点服务名称}.
httpEndpoints 否 x-apigateway-backend.httpEndpoints HTTP类型服务定义。 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义。
导入CSE微服务 导入微服务引擎(Cloud Service Engine,简称CSE)的微服务,提供API注册开放CSE服务能力。导入时,可同步创建API分组。具体步骤请参见通过CSE微服务导入API。
后端服务签名校验开发:若API在API网关上绑定了签名密钥,则API网关向该API的后端服务发送请求时会携带相应的签名信息。该API的后端服务需要集成API网关提供的SDK,并对请求中的签名信息进行校验。
自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 自定义认证的具体使用指导,可参考《API网关开发指南》的自定义认证相关章节。
开放API 将成熟的业务能力(如服务、数据等)作为后端服务,在API网关中开放API,提供给API调用者使用,实现业务能力变现。
下线APIG的API:您可以通过下线API功能,将API从相关环境中下线,暂停对外提供的服务。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 导入导出API:您可以通过API设计文件、CSE微服务、CCE工作负载、导入API到APIG。
这种场景,推荐考虑使用对象存储服务。 专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。
CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参见跨域调用APIG开放的API。 跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力,可快速、灵活的实现API的跨域访问。
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。
API定义范围 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。
适用计费项 使用量(包含API调用量和公网流量) 如果后端服务与API网关不在同一区域,或后端服务不在华为云,将会额外收取API网关到后端服务的流量费用。 适用场景 适用于API需求较小的场景。 父主题: 计费模式
如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量。通过环境变量,可实现同一个API,在不同环境中调用不同的后端服务。 例如创建API时,后端服务请求Path中定义了变量“Path”。
全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将API定义备份为Swagger或OpenAPI文件。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。
配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Key、Secret),在调用API时,API网关服务根据密钥对进行身份核对,完成鉴权。Key唯一且不可重置,支持重置Secret。
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。
通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。