检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。
长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 导入API前,您需要在导入的API定义文件中补全Swagger扩展定义。如果“扩展定义”中未包含需要的定义,请提前在API网关中创建。
@#$%-/=,且只能以英文、数字和+、/开头,长度为64~180个字符。 使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。
10 表4 ResponseInfoHeader 参数 是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串
支持英文,数字,下划线,且只能以英文开头,3-64个字符,同一实例下不允许重名。
支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 策略类型 固定为“响应缓存”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。
支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 策略类型 固定为“流量控制2.0”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 流控类型 推荐使用高性能流控。
可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample String 失败返回示例,描述API的异常返回信息 sl_domain String 分组的二级域名
publicips Array of IpDetails objects 公网入口地址列表 privateips Array of IpDetails objects 私网入口地址列表 unreliable_ips Array of strings 不建议使用的实例入口列表:分组子域名解析未指向到该列表的
支持英文、数字、下划线、中划线,1-64个字符。 responses 否 Map<String,ResponseInfo> 错误类型的响应定义,其中key为错误类型。
后端实例类型为ecs时必填,支持英文,数字,“-”,“_”,1 ~ 64字符。 最大长度:255 ecs_name String 后端云服务器的名称。 后端实例类型为ecs时必填,支持汉字,英文,数字,“-”,“_”,“.”,1 ~ 64字符。
支持英文、数字、下划线、中划线,1-64个字符。 responses 否 Map<String,ResponseInfo> 错误类型的响应定义,其中key为错误类型。
表4 共享版与专享版API网关功能差异 规格分类 规格描述 共享版 专享版 基本功能 精细化流控 √ √ IP&用户访问控制 √ √ 安全认证 √ √ API生命周期管理 √ √ 自定义域名 √ √ Swagger导入导出 √ √ 支持VPC通道(负载通道) √ √ API参数编排
支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 策略类型 固定为“断路器”。 描述 填写策略的描述信息。长度为1~255个字符。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 策略生效范围 单个API生效 对单个API进行控制。
例如,VPC中包含6台ECS,已创建一条VPC通道,其中ECS 01和ECS 04已添加到VPC通道中,此时API网关通过VPC通道可以直接访问VPC中的ECS 01和ECS 04。 图1 通过API网关访问VPC通道中的ECS 前提条件 已创建云服务器。
支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3-64个字符。 类型 分“基础流控”和“共享流控”两类。 基础流控针对单个API进行流量统计和控制。 共享流控针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长,单位可选秒、分钟、小时、天。
创建自定义认证 操作场景 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。
@#$%-/=,且只能以英文、数字和+、/开头,64-180个字符。