检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改API 功能介绍 修改指定API的信息,包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。
表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String App Code值 app_id String APP的ID create_time
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。
功能总览 功能总览 全部 API网关 购买API网关 开放API 调用API 导入导出API 自定义认证 API SDK OBS 2.0支持 API网关 API网关(API Gateway)提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建
表2 参数说明 名称 是否必选 类型 说明 config_name 否 String 配置项的名称 config_id 否 String 配置项的编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息
项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。
请求消息 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
请求消息样例: { "name": "DEVELOP", "remark": "开发环境" } 响应消息 表4 参数说明 参数 类型 说明 id String 环境ID name String 环境名 create_time Timestamp 创建环境的时间 remark String
请求消息样例: { "name": "DEVELOP", "remark": "开发环境" } 响应消息 表4 参数说明 参数 类型 说明 id String 环境ID name String 环境名 create_time Timestamp 创建环境的时间 remark String
请求消息 无 响应消息 表3 参数说明 名称 类型 说明 offsell_nums Integer 未上架的API分组个数 onsell_nums Integer 已上架的API分组个数 响应消息样例: { "offsell_nums": 1, "onsell_nums": 2
删除签名密钥 操作场景 如果某一个密钥不再提供服务,则可以将其删除。 前提条件 已创建密钥。 操作步骤 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 通过以下任意一种方法,弹出对话框。 在待删除的密钥所在行,单击“删除”。
500 Internal Server Error 服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。
创建告警规则 操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。
请确保您选择的子网段有足够多的私有地址可用,私有地址可在虚拟私有云服务的控制台查询。 负载 创建实例后,不支持修改虚拟私有云(负载)。 负载均衡模式为LVS模式或ELB模式。当前仅墨西哥城一、北京一区域支持LVS模式,其他区域支持ELB模式。
待废弃字段 tags 否 []String 标签 包含一个服务名称标签和若干其它标签 服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark
无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs 字典数据类型 本次返回的环境列表 表4 envs参数说明 参数 类型 说明 id String 环境ID name String
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。
variable_name 否 String 变量名 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息
env_id String 环境编号 group_id String API分组编号 variable_name String 变量名 variable_value String 变量值 响应消息样例: { "total": 2, "size": 2, "variables
类型 说明 name 否 String 环境名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息