检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息。
企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 方案架构 图1 后端服务器访问原理 方案优势 方案一:API分组通过域名方式对外提供服务,具备更强的可扩展性。 方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 在AP
开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能,如果不支持请联系技术支持。 缺省值:false member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
API网关服务的管理员权限。拥有该权限的用户可以使用专享版和共享版API网关服务的所有功能。 系统角色 如果在操作过程中涉及其他服务资源的创建、删除、变更等,则还需要在同项目中勾选对应服务的Administrator权限。 APIG FullAccess API网关服务所有权限。
分组的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 url_domain 是 String 自定义域名。 长度为0-255位的字符串,需要符合域名规范。 请求消息样例: { "url_domain": "www.MyCompany.com" } 响应消息 表4 参数说明
type" 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-backend 是 String API后端服务定义。 type 是 String 后端服务类型,支持HTTP、HTTP-VPC、FUNCTION、MOCK。 parameters 否 x-apigateway-backend
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
中获取。 action 是 String 必须为delete 请求消息 表3 参数说明 参数 是否必选 类型 说明 acl_bindings 否 String Array 需要解除绑定的ACL策略ID列表 请求消息样例: { "acl_bindings": ["81efc
只支持部分region自定义。 请求消息样例: { "name": "app_001", "remark": "第一个APP", "app_key": "app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表4
API的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 env_id 是 String 环境的编号,即:API需要发布到哪个环境 remark 否 String 对本次发布动作的简述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: {
只支持部分region自定义。 请求消息样例: { "name": "app_001", "remark": "第一个APP", "app_key": "app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表4
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
配置API认证的凭据访问控制 凭据访问控制可控制访问API的凭据IP地址,保护后端服务。您可以为凭据设置访问控制策略,允许/禁止某个IP地址的凭据访问API。 配置凭据的访问控制策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String App Code值 app_id String APP的ID create_time Timestamp 创建时间 响应消息样例: { "app_code":
instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型:
private_key 是 String 私钥内容。 请求消息样例: { "cert_content": "example", "name": "test_ssl", "private_key": "example" } 响应消息 表4 参数说明 名称 类型 说明 id String
private_key 是 String 私钥内容。 请求消息样例: { "cert_content": "example", "name": "test_ssl", "private_key": "example" } 响应消息 表4 参数说明 名称 类型 说明 id String
instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 分组的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain
instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key
0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 分组的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain