检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
ResponseInfoHeader 参数 参数类型 描述 key String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 状态码: 400 表8
String 项目ID,获取方式请参见获取项目ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 on_sell_status
系统默认分配的子域名列表 register_time Timestamp 创建时间 update_time Timestamp 最近修改时间 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 请求参数 表2 请求Header参数
String API的请求协议 HTTP HTTPS app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 domain 否 String API的访问域名,如果使用自定义入方向端口的特性时,需要带上端口信息,用冒号分隔,例如test
响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 signs Array of SignatureWithBindNum objects 本次查询到的签名密钥列表 表5 SignatureWithBindNum 参数
开放API 开放API流程 创建API分组 添加API的SSL证书(可选) 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 authorizer_id 是 String 自定义认证的编号 请求参数 表2 请求Header参数 参数 是否必选
Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 响应消息样例: {
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
3:审核中 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains Array of UrlDomainsResp
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
Integer 正常阈值。判定VPC通道中主机正常的依据为:连续检查x成功,x为您设置的正常阈值。 最小值:1 最大值:10 threshold_abnormal 是 Integer 异常阈值。判定VPC通道中主机异常的依据为:连续检查x失败,x为您设置的异常阈值。 最小值:1 最大值:10 time_interval
将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
ingress_https_port 否 Integer 访问该域名绑定的https协议入方向端口,-1表示无端口且协议不支持,可使用443默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTPS协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认443
华为云账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的IAM用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,I