检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
近6小时数据每2小时刷新一次。 近一天数据每2小时刷新一次。 近一周和近一月数据每天刷新一次。 如果需要查看实例、实例节点的监控信息,请单击“查看更多监控”,查看更多的监控数据。 监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中,具体步骤请参见配置OBS数据存储。
请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持 * / %- _ . 等特殊字符,总长度不超过512,且满足URI规范。 说明: 需要服从URI规范。 auth_type String API的认证方式 NONE:无认证 APP:APP认证 IAM:IAM认证 AUTHO
String 发布的环境id publish_id String 发布记录的编号 arrange_necessary Integer 是否需要编排 tag String 服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 约束与限制 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,h
选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端
设置包年/包月资源到期后转按需。 单个资源到期转按需:在“手动续费项”页签中选择需要更改计费模式的APIG实例,单击操作列“更多 > 到期转按需”。 批量资源到期转按需:在“手动续费项”页签中选择需要更改计费模式的APIG实例,单击列表左上角的“到期转按需”。 单击“到期转按需项
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/openapi
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi/apis?env_id
member_group_name 否 String VPC通道后端云服务组的名称 precise_search 否 String 指定需要精确匹配查找的参数名称,多个参数需要支持精确匹配时参数之间使用“,”隔开。 当前支持member_group_name。 请求参数 表3 请求Header参数
(黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
发布API 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到不同环境后,会调用不同的后端服务吗? 调试API的时候,如何指定环境?
选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则AP
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1/{project_id}/apigw/instance
SignedHeaders=SignedHeaders, Signature=signature 需要注意的是算法与Access之前没有逗号,但是SignedHeaders与Signature之前需要使用逗号隔开。 得到的签名消息头为: Authorization: SDK-HMAC-SHA256
了解每种计费项的计费因子、计费公式等信息,请参考计费项。 续费 包年/包月在到期后会影响API网关的正常运行。如果您想继续使用API网关,需要在规定的时间内为API网关进行续费,否则实例资源将会被冻结,数据也可能会丢失。续费包括手动续费和自动续费两种方式,您可以根据需求选择。了解更多关于续费的信息,请参见续费概述。
缺省值:20 id 否 String 流控策略编号 name 否 String 流控策略名称 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
参数类型 描述 action 是 String 需要进行的操作。 online:发布 offline:下线 env_id 是 String 环境的编号,即:API需要发布到哪个环境 api_id 是 String API的编号,即:需要进行发布或下线的API的编号 remark 否
密钥。支持英文,数字,“_”,“-”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 128个字符。用户自定义APP的密钥需要开启配额开关。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 编号 name String