检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用APIG专享版开放云容器引擎CCE工作负载实施步骤 准备CCE工作负载信息 创建集群。 登录云容器引擎控制台,在“集群管理”页面购买CCE Standard集群或CCE Turbo集群。此处选择CCE Standard集群,容器网络模型为“VPC网络”,具体操作步骤请参见购买CCE集群。 集群创建完成后,记录容器网段。
参数说明 名称 是否必选 类型 说明 api_id 是 String API的编号 env_id 否 String 环境的编号 env_name 否 String 环境的名称 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的API历史版本总数
String API所属分组的名称 remark String API描述 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 auth_type String API的认证方式 req_uri
API的描述信息 api_type Integer API类型 envname String API授权绑定的环境名称 env_id String API授权绑定的环境编号 auth_role String 授权者 auth_time String 授权创建的时间 appid String
签名密钥的key sign_secret String 签名密钥的密钥 env_id String API所属环境的编号 env_name String API所属环境的名称 binding_time Timestamp 绑定时间 publish_id String API的发布编号
is_include_special_throttle Integer 是否包含特殊流控:1、包含;2、不包含 env_name String 流控策略生效的环境(即在哪个环境上有效) type Integer 流控策略的类型 bind_id String 流控策略与API绑定关系编号 bind_time Timestamp
签名密钥的key sign_secret String 签名密钥的密钥 env_id String API所属环境的编号 env_name String API所属环境的名称 binding_time Timestamp 绑定时间 publish_id String API的发布编号
Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)对调用请求内容进行签名认证。 调用API示例 获取Token,并设置成环境变量,Token用于后续调用其他接口鉴权。 获取用户Token,请求内容示例如下:
协议默认使用80端口,HTTPS协议默认使用443端口。 如果后端服务地址中需要携带环境变量,则使用“#变量名#”的形式将环境变量添加到后端服务地址中,如#ipaddress#。支持添加多个环境变量,如#ipaddress##test#。 自定义host头域(可选) 仅当“使用VPC通道”选择“使用”时可配置。
is_include_special_throttle Integer 是否包含特殊流控:1、包含;2、不包含 env_name String 流控策略生效的环境(即在哪个环境上有效) type Integer 流控策略的类型 bind_id String 流控策略与API绑定关系编号 bind_time Timestamp
API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instance
API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
确认无误后,单击“提交”,完成配置。 单击“立即导入”,在弹窗中选择是否现在发布API到环境。 如果选择“现在发布”,还需要选择API要发布的环境,将API分组下的所有API发布到环境上。 如果选择“稍后发布”,请参考发布API。 单击“确定”,跳转到“API运行”页面,可查看分组下的API。
完成API的创建、发布等工作 此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。 其他相关操作包括“API分组”、“API管理”和“环境管理”等。 (可选)配置API的流量控制策略 流量控制主要用来限制单位时间内API的被调用次数,保护后端服务的稳定。 此部分操作在API网关服务中完成,您可以参考流量控制章节。
操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。 已搭建完成后端服务。
产品优势 开箱即用的服务 只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的
的CORS功能增加的响应头。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
小为1K,超出部分会被截断。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
隔开。 Allowed Headers Access-Control-Allow-Headers响应头,指定XMLHttpRequest请求中允许携带的请求头字段,多个请求头之间使用英文逗号隔开。 其中,简单请求头Accept、Accept-Language、Content-La
API的后端服务类型为Mock时,不支持绑定流量镜像策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。