检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id
String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
dev:开发定义,包括未发布的api的前后端定义 缺省值:spec type 否 String 导出的API定义的格式 缺省值:json version 否 String 导出的API定义版本,默认为当前时间 apis 否 Array of strings 导出的API ID列表 响应参数
E操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建API分组接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。 name为API分组的名称。 remark为API分组的描述。 POST
无法创建API是什么原因? API免费创建。如果被限制操作,可能原因为用户欠费,请及时充值。 计费相关的详细指导,请参考计费说明。 父主题: 开放API
如何通过APIG访问公网后端服务? 通过开启公网入口访问,允许外部服务调用API。 如果您在调用API遇到网络问题,请参考调用API失败的可能原因。 父主题: 调用API
调用API报“414 Request URI too large” 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。 有关API调用的报错信息,请参考错误码。 父主题: 调用API
SSL证书解绑域名 功能介绍 SSL证书解绑域名。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/detach
ingress_https_port 否 Integer 访问该域名绑定的https协议入方向端口,-1表示无端口且协议不支持,可使用443默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTPS协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认443
ect-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 version_id 否 String API版本的编号 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID api_id
类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance
call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
URI DELETE /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
后端服务签名校验开发:若API在API网关上绑定了签名密钥,则API网关向该API的后端服务发送请求时会携带相应的签名信息。该API的后端服务需要集成API网关提供的SDK,并对请求中的签名信息进行校验。
使用APP认证方式的API,需要配置调用授权,把API授权给指定的凭据。API调用者使用凭据的Key和Secret进行API请求的安全认证,也可以使用凭据的AppCode进行简易认证。 如果您需要限制API调用者在某个时间周期内的API调用次数,可以通过配置API认证凭据的配额控制来实
0/apigw/apps/{app_id}/app-codes/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String App Code的编号 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
API会出现失败场景。 选择VPC网络模型的CCE集群时,您需要在实例详情界面的路由配置中添加CCE集群的容器网段,否则导入后调用API会出现失败场景。 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测工作负载下所有实例的地址变化,并更新到负载通道中。 前提条件 已创建CCE工作负载。