检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
参数 是否必选 类型 说明 type 是 String 策略条件类型,支持equal、enum、pattern value 是 String 策略条件值 origin 是 String 策略条件输入来源,支持source、request parameter 否 String 策略
API提供的默认网关响应“default”也可以编辑修改。 您可以新增多个网关响应,支持同一分组下不同API配置不同的网关响应内容。 网关响应所定义的错误类型固定且不可修改,具体见网关错误响应类型说明。 响应内容支持调用API网关运行时变量($context变量),具体见API网关运行时可获取变量。
例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。 创建环境变量 选择“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“变量管理”页签。
name 是 String 签名密钥的名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8
头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content
头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content
name 是 String 签名密钥的名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8
务时,保障后端服务的安全。 调试API 验证API服务的功能是否正常可用。 发布API 把API发布到环境中,API只有在发布到环境后,才支持被调用。 调用API 企业或开发者如何获取并调用他人在API网关开放的API,减少开发时间与成本。 图3 API网关服务调用API 调用API的业务使用流程如下图所示。
监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 共享版操作指导(仅存量用户使用)
响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 offsell_nums Integer 未上架的API分组个数 暂不支持 onsell_nums Integer 已上架的API分组个数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
"apiId":"$context.apiId"} JSON体的内容可以按需定制,包括增减字段内容。 每个分组最多可新增4个网关响应。 最多支持10个响应头自定义,响应头的key支持数字、英文字母和下划线(1到128位),value可以引用运行时变量(可以引用的变量见API网关运行时可获取变量),value不能包含“[[”和“]]”。
API监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 监控分析
附录 分页显示查询结果 过滤查询结果 HTTP状态码 错误码 实例支持的APIG特性 获取项目ID 获取账号名和账号名ID
拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE: 请求参数校验失败、不支持的HTTP方法 DEFAULT_4XX: 其它4XX类错误 DEFAULT_5XX: 其它5XX类错误 THIRD_AUTH_FAILURE:
专享版-实例特性管理 实例配置特性 查看实例特性列表 查询实例支持的特性列表 父主题: 专享版API(V2)
String 参数值,当参数来源为REQUEST时,值为请求参数名称 in 是 String 参数位置,支持header、query、path origin 是 String 参数映射来源,支持REQUEST、CONSTANT description 否 String 参数含义描述 父主题:
单击API所属分组名称,进入分组详情。 在“分组信息”页签中单击“绑定独立域名”。 表2 配置独立域名 参数 配置说明 域名 填写已备案的域名。 支持最小TLS版本 此处选择“TLS1.2”。 支持http to https自动重定向 默认关闭。 单击“确定”。 绑定证书。 在已绑定独立域名所在行单击“选择SSL证书”。
API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要按需使用。实例版本说明,请参考产品规格。如果您当前使用的实例版本不能满足需要,API网关支持升级产品版本,例如从“基础版”升级到“专业版”或者铂金版,并且对现有业务没有影响。 实例版本单价,请参考价格详情中的包年/包月计费价格。 包年/包月计费。
参数 是否必选 类型 说明 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义密钥值。 请求消息样例: { "app_secret":
CONSUMER:API消费者授权 auth_tunnel String 授权通道类型 NORMAL:普通通道 GREEN:绿色通道 暂不支持,默认NORMAL auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array