检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 无 响应示例 状态码: 201 Created { "app_code" : "fdc8d90a30174460a91ddacfa54d6
更改,每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 公网独立域名需要备案,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。
API的版本 CRU 否 req_protocol String API的访问协议 HTTP HTTPS BOTH:同时支持HTTP和HTTPS 默认:HTTPS CRU 否 req_method String API的访问方式 GET POST PUT DELETE HEAD PATCH
说明 api-limit 是 Integer API访问次数限制 user-limit 否 Integer 用户访问次数限制 app-limit 否 Integer 应用访问次数限制 ip-limit 否 Integer 源IP访问次数限制 interval 是 Integer 流控策略时间周期
API的版本 CRU 否 req_protocol String API的访问协议 HTTP HTTPS BOTH:同时支持HTTP和HTTPS 默认:HTTPS CRU 否 req_method String API的访问方式 GET POST PUT DELETE HEAD PATCH
说明 api-limit 是 Integer API访问次数限制 user-limit 否 Integer 用户访问次数限制 app-limit 否 Integer 应用访问次数限制 ip-limit 否 Integer 源IP访问次数限制 interval 是 Integer 流控策略时间周期
THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE:
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
ThrottleForApi 参数 参数类型 描述 app_call_limits Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 name String 流控策略名称。支持汉字,英文
SignatureBinding relieveSignatureBinding 创建访问控制 Acl createAcl 删除访问控制 Acl deleteAcl 批量删除访问控制 Acl batchDeleteAcl 更新访问控制 Acl updateAcl 增加流控黑名单 Acl addAclValue
0.1 访问控制策略最多支持设置100个IP地址或网段,且最大长度为5120。 如果使用IPv6地址,请先确保对应实例支持IPv6协议。 如果不开启访问控制策略,默认允许所有IP访问;如果开启访问控制策略,设置“白名单”类型,但是没有配置任何IP地址,则禁止任何IP访问;如果开启
最多20个。无tag过滤条件时返回全量数据。 数组长度:0 - 20 sys_tags 否 Array of TmsKeyValues objects 企业项目.仅op_service权限可以使用此字段做资源实例过滤条件. 无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。
API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的默认子域名进行API调试,每天最多可以访问默认子域名1000次。 创建API 把已有后端服务封装为标准RESTFul API,并对外开放。 API创建成功后,您可根据业务需求对API设置访问策略: 流控控制
VPC_NUM_LIMIT:租户可以创建的VPC通道个数限制 VPC_INSTANCE_NUM_LIMIT:每个VPC通道上可以绑定的弹性云服务器个数限制 API_PARAM_NUM_LIMIT:每个API可以设置的参数个数限制 API_USER_CALL_LIMIT:每个租户的API单位时间内的请求默认限制
参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 sign_id 是 String
参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 throttle_id 是 String
此部分操作在API网关服务中完成,您可以参考流量控制章节。 (可选)配置API的访问控制策略 访问控制主要用于禁止或仅允许某些账号/源访问IP的API调用。 此部分操作在API网关服务中完成,您可以参考访问控制章节。 在华为云商店中,入住卖家中心,将您的API开放售卖。 将API上架到华为云商店售卖。
API名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API的总数 size Integer 本次返回的列表长度
可能会发生闪断。维护操作通常几个月一次'。 ingress_ip String 实例入口,虚拟私有云访问地址 ingress_ip_v6 String 实例入口,虚拟私有云访问地址 (IPv6) user_id String 实例所属用户ID nat_eip_ipv6_cidr
调用API网关中开放的API报错,请按以下顺序排查可能原因: 调用API所使用的域名、请求方法、路径不正确。 比如创建的API为POST方法,您使用了GET方法调用。 比如访问的URL比API详情中的URL少一个“/”也会导致无法匹配上此API,例如http://7383ea59c0cd49a2b61d0fd1d351a619