正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
子网中可用私有地址数量 API网关专享实例的基础版、专业版、企业版,以及铂金版分别需要3、5、6、7个私有地址。在铂金版的基础上,铂金版X依次增加4个私有地址。请确保您选择的子网段有足够多的私有地址可用,私有地址可在虚拟私有云服务的控制台查询。 网络环境准备 负载 虚拟私有云(Virtual
物理隔离要求较低,能够开箱即用,快速实现API能力开放。 中大型用户。 专享版API网关拥有物理隔离的独立集群, 更丰富的特性。 满足内部API调用跟API开放,专享独立的公网带宽。 API网关的共享版与专享版在功能上的异同点如下表所示。 表3 共享版与专享版API网关功能差异 规格分类 规格描述 共享版
重置密钥 功能介绍 重置指定APP的密钥。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/secret/{id} URI中的参数说明如下表所示。 表2 参数说明
您可以在“费用 > 账单管理”查看资源的费用账单,以了解该资源在某个时间段的使用量和计费信息。 账单上报周期 包年/包月计费模式的资源完成支付后,会实时上报一条账单到计费系统进行结算。 按需计费模式的资源按照固定周期上报使用量到计费系统进行结算。按需计费模式产品根据使用量类型的不同,分为按小时
success_count Number 删除成功的ACL策略数量 failure Array 删除失败的ACL策略及错误信息 表5 failure参数说明 名称 类型 说明 acl_id String 删除失败的ACL策略ID acl_name String 删除失败的ACL策略名称 error_code
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。
户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
api_ids 是 Array of strings API的编号列表 可以选择租户自己的API,也可以选择从云商店上购买的API。 app_ids 是 Array of strings APP的编号列表 env_id 是 String 需要授权的环境编号 请求参数样例: { "api_ids":
仅在API请求的“请求Path”中存在“{}”时,支持修改。 查询参数 Query的参数与参数值。 请求头 HTTP Headers的参数与参数值。 请求体 仅在API请求的“Method”定义为“PATCH”/“POST”/“PUT”时,支持修改。 不同类型的请求,调试界面展现的信息项有差异。 添加请求参数后,单击“发送请求”。
第三方认证策略:通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。 响应缓存策略:将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 不同的策略类型,策略内容的配置不同:
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号,可通过查询APP列表获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
系统默认分配的子域名 register_time Timestamp 创建时间 update_time Timestamp 最近修改时间 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
Project”对话框,选择“PHP”,单击“Next”。 图2 PHP 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后php的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程php的目录结构 “signer.php”为示例代码,请根据实际情况修改参
查看专享版实例创建进度 功能介绍 查看专享版实例创建进度 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/progress 表1 路径参数 参数 是否必选 参数类型 描述 project_id
将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
domain 否 String API的访问域名,未提供时根据mode的取值使用如下默认值: DEVELOPER API分组的子域名 MARKET 云商店为API分组分配的域名 CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024