检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题： 管理API
签名前准备 获取签名密钥信息： 在APIG实例控制台选择“API管理 > API策略 > 策略管理”，单击签名密钥名称进入详情页面，在“策略内容”区域查看Key和Secret。 父主题： 对后端服务进行签名
授权APIG的API API在创建后，通过指定授权给某些凭据，让指定凭据能够调用API。 仅在API为APP认证时，才支持授权给凭据。 单个凭据最多同时授权1000个API。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面
配置API的调用域名 在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。最多可以添加5个独立域名，不限访问次数。 独立域名可分为内网域名和公网域名两种： 内网域名：部署在云服务平台内的业务系统，可以使用内网域名访问API。 公网域名：部署在云服务平台外的业务系统
配置APIG实例参数 配置参数提供了实例内组件的公共参数配置，通过修改配置参数，可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断，建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上
克隆APIG的API API网关支持克隆已创建的API，提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略，如果需要绑定策略请手动操作。 前提条件 已创建API，如果未创建API，请通过APIG创建REST API。 操作步骤
配置API的参数编排规则 API网关支持对API进行参数编排，根据请求参数取值，配置不同算法规则，映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理
创建自定义认证 操作场景 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时
查看或编辑APIG的API信息 API列表支持查看当前实例下所有的API，包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API，支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
配置APIG实例标签 通过标签功能对实例资源进行标记，批量分类实例资源，实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务（Tag Management Service，简称TMS）中过滤查询资源、分析资源及管理资源。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择
如何将API服务上架到华为云商店上售卖？ API服务上架到华为云商店，您需要按如下流程完成部署和配置： 完成API的创建、发布等工作 此部分操作在API网关服务中完成，您可以参考《API网关用户指南》。 其他相关操作包括“API分组”、“API管理”和“环境管理”等。 （可选）配置
配置API的自定义认证 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时
自定义API的错误响应信息 网关响应指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为
产品优势 开箱即用的服务 只需在管理控制台配置，即可快速创建API。提供页面调试工具，简化API开发。可同时发布一个API到多个环境，快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理，从设计、开发、测试、发布、运维、上架、下架等， 实现完整的API
查看或编辑APIG实例信息 实例创建完成后，可在控制台查看和编辑实例的配置信息。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上，单击“查看控制台”或实例名称。 在“实例信息”页签，查看或编辑实例的配置信息。 表1 实例信息 可编辑项
过滤查询结果 查询资源列表时（例如，查询API列表），系统支持按照查询对象的属性过滤查询结果。 示例： GET /v1.0/apigw/apis?id=xxxx 父主题： 附录
变更APIG实例规格 当实例规格无法满足您的业务需求时，您可以进行规格变更操作升配到更高规格版本。 规格变更过程中，长连接会发生闪断，需要重新建链，建议业务低峰期进行规格变更。 只能升配到更高规格，无法降配规格。 规格变更时，出私网IP会发生变化，如有相关防火墙配置或者白名单配置需要提前放通
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
