检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建专享版实例（按需） 功能介绍 创建按需专享版实例 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目
导出APIG的API APIG支持把创建的API以JSON、YAML、YML文件的格式导出，支持导出单个API和批量导出API。 导出API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出
调用API API提供者在API网关开放自己的API后，API调用者从API网关中调用API。 调用限制 如果您使用调试域名（创建API分组时系统分配的调试域名）访问API，该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前，您需要向API提供者获取API
约束与限制 实例 表1 实例约束与限制 限制项 约束与限制 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”权限即可。
API调用授权概述 API调用者在调用使用APP认证的API时，可以通过凭据进行API认证或AppCode进行简易的API认证。APP认证类型包含下表中列举的类型，更多详情请参考调用APIG开放的API。下文介绍凭据和AppCode的配置，您可以根据业务需求选择其中一种进行认证。
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证
通过API设计文件导入API 将Swagger或OpenAPI定义的API导入到API网关，支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 注意事项 API网关中API分组和API的配额满足需求。 如果使用Swagger info或OpenAPI
APIG的API错误码说明 当调用API时，可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 通过APIG接口管理API，发生错误时，产生的错误码请参考错误码。 使用APIG错误码时，请以错误码（如APIG.0101）为准，错误信息并非固定不变
方式二：通过导入CCE工作负载的方式开放CCE工作负载 导入CCE工作负载。 进入API网关控制台，在左侧导航栏上方选择实例。 在左侧导航栏中选择“API管理 > API分组”。 单击“创建API分组 > 导入CCE工作负载”。 填写导入CCE工作负载的信息。 表1 工作负载信息配置
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。 Token认证：通过Token认证调用请求
Token认证 操作场景 当您使用Token认证方式调用API时，需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证调用请求。 AK
怎样保护API的调用安全？ 使用身份认证 创建API时，为API调用增加身份认证，如使用IAM认证或API网关提供的APP认证，防止API被恶意调用。 设置访问控制策略 从IP地址（或地址区间）以及账号等不同维度，设置白名单/黑名单。 将API绑定流控策略，通过流控策略保护API。
发布APIG创建的API 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 约束与限制 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中
使用APIG专享版开放CCE工作负载操作流程 准备CCE工作负载信息 在通过API网关将容器的工作负载对外开放前，需要在云容器引擎控制台创建CCE集群（VPC网络模型）或Turbo集群。 开放CCE工作负载 方式一：在API网关中直接创建负载通道并开放API，通过负载通道访问CCE
调用APIG开放的API API提供者在API网关开放自己的API后，API调用者从API网关中调用API。 约束与限制 如果您使用调试域名（创建API分组时系统分配的调试域名）访问API，该调试域名每天最多可以访问1000次。 如果在API网关控制台“API管理 > API策略
查看或编辑APIG实例信息 实例创建完成后，可在控制台查看和编辑实例的配置信息。 查看或编辑实例信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上，单击“查看控制台”或实例名称。 在“实例信息”页签，根据下表参数说明，查看或编辑实例的配置信息。
变更APIG的实例规格 当实例规格无法满足您的业务需求时，您可以进行规格变更操作升配到更高规格版本。 约束与限制 规格变更过程中，长连接会发生闪断，需要重新建链，建议业务低峰期进行规格变更。 只能升配到更高规格，无法降配规格。 规格变更时，出私网IP会发生变化，如有相关防火墙配置或者白名单配置需要完全放通
修改自定义认证 功能介绍 修改自定义认证 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id} 表1 路径参数 参数 是否必选 参数类型
创建自定义认证 功能介绍 创建自定义认证 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers 表1 路径参数 参数 是否必选 参数类型 描述 project_id
准备CCE工作负载信息 创建集群。 登录云容器引擎控制台，在“集群管理”页面购买CCE Standard集群或CCE Turbo集群。此处选择CCE Standard集群，容器网络模型为“VPC网络”，具体操作步骤请参见购买CCE集群。 集群创建完成后，记录容器网段。 在APIG专享版实例的
