检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/api-groups/{
在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。
访问密钥ID:输入访问密钥ID(包含临时访问凭证和永久访问密钥)。 时间范围:可选择查询最近1小时、最近1天、最近1周的操作事件,也可以自定义最近7天内任意时间段的操作事件。 您可以参考云审计服务应用示例,来学习如何查询具体的事件。 在事件列表页面,您还可以导出操作记录文件、刷新列表、设置列表展示信息等。 在搜索
创建告警规则 操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API
导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/i
访问密钥ID:输入访问密钥ID(包含临时访问凭证和永久访问密钥)。 时间范围:可选择查询最近1小时、最近1天、最近1周的操作事件,也可以自定义最近7天内任意时间段的操作事件。 您可以参考云审计服务应用示例,来学习如何查询具体的事件。 在事件列表页面,您还可以导出操作记录文件、刷新列表、设置列表展示信息等。 在搜索
异步导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/insta
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instanc
custom_data_log1 用户自定义日志字段值1。 40 custom_data_log2 用户自定义日志字段值2。 41 custom_data_log3 用户自定义日志字段值3。 42 custom_data_log4 用户自定义日志字段值4。 43 custom_data_log5
AUTHORIZER:自定义认证 auth_opt 否 AuthOpt object 认证方式参数 authorizer_id 否 String 前端自定义认证对象的ID backend_type 是 String 后端类型: HTTP:web后端 FUNCTION:函数工作流 MOCK:模拟的后端
说明 function-urn 是 String 函数URN地址。 version 是 String 函数版本。 invocation-type 是 String 函数调用类型,支持异步或同步。 timeout 否 Number 函数超时时间,单位毫秒,缺省值为5000,取值范围为1~60000。
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_i
AUTHORIZER:自定义认证 auth_opt 否 字典数据类型 认证方式参数 authorizer_id 否 String 前端自定义认证对象的ID backend_type 是 String 后端类型: HTTP:web后端 FUNCTION:函数工作流 MOCK:mock
{"x-stage": "RELEASE"}, "body") 进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 X-Sdk-Date是一个必须参与签名的请求消息头参数。
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
单击分组名称,进入“分组信息”页面。 在“API运行”页面,单击“更多 > 克隆”。 根据下表参数说明,自定义API名称和API前端路径,单击“确定”。 表1 克隆API配置 参数 说明 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 支持中文、英文
失败返回示例,描述API的异常返回信息 response_id String 分组自定义响应ID backend_api 字典数据类型 后端服务:web后端详情 mock_info 字典数据类型 后端服务:MOCK详情 func_info 字典数据类型 后端服务:函数工作流后端详情 req_params 字典数据类型
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选