检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自动生成APP Code 功能介绍 创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes
自动生成App Code 功能介绍 创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{app_id}/app-codes
如何调用API 构造请求 认证鉴权 返回结果
如何通过APIG访问公网后端服务? 通过开启公网入口访问,允许外部服务调用API。 如果您在调用API遇到网络问题,请参考调用API失败的可能原因。 父主题: 调用API
查询变量列表 功能介绍 查询分组下的所有环境变量的列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables 表1 路径参数 参数 是否必选 参数类型 描述 project_id
非“www.exampleDomain.com”之类的网络域名。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/acls 表1 路径参数 参数 是否必选 参数类型 描述 project_id
选择环境、API分组和API。 单击“确定”,完成API绑定。 添加APPCode认证信息。 在凭据列表中单击已创建的凭据名称,进入凭据详情。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中选择“自动生成”生成方式。 单击“确定”。 调用API。 使用接口测试工具配置API请求和认证信息。
参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 throttle_specials Array of ThrottleSpecialInfo objects 本次查询返回的特殊配置列表 表5 ThrottleSpecialInfo 参数
准备网络环境 负载 虚拟私有云(Virtual Private Cloud,简称VPC)。实例需要配置虚拟私有云(负载),在同一负载中的资源(如ECS),可以使用实例的私有地址调用API。 在创建实例时,建议配置和您其他关联业务相同负载,确保网络安全的同时,方便网络配置。 安全组
添加多个后端策略后,通过不同的策略条件,请求被转发到不同的后端服务中。 单击添加策略后端。 后端策略增加的参数,具体如表9所示,其他参数说明参考表4、表5和表6。 表9 后端策略参数 参数 说明 后端策略名称 您自定义的名称,用于识别不同的后端策略。 支持英文、数字、下划线和中划线
功能介绍 实例更新或绑定EIP(仅当实例为LVS类型时支持) 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/eip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
构造请求 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息和API请求参数信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis 表1 路径参数
应用场景 当用户后端服务器所在的VPC与创建实例所选择的VPC处于不同的场景时,该如何完成服务配置,以实现跨VPC对接?本文以Elastic Load Balance(弹性负载均衡ELB)为例,讲述如何在API网关上开放内网ELB中的服务。 方案架构 图1 API网关跨VPC开放后端服务
查询环境列表 功能介绍 查询符合条件的环境列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/envs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
创建按需专享版实例 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数 表2 请求Header参数
息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。
使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
0支持 购买API网关 修改子网网络信息 本小节指导您顺利购买专享版实例,实例创建完成后,才能创建API并对外提供服务。如果您对服务的性能需求不大,可使用共享版API网关,直接创建与管理API,而无需单独购买专享版实例。 删除子网 当无需使用子网、需要释放网络资源时,可删除子网。 支持区域:
strings 终端节点列表 数组长度:1 - 50 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表5 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long