检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义，参考表 前端parameters参数说明 responses 否 Object 响应定义，参考表9 security
参数名称 说明 导入方式 导入方式包含以下2种： 生成新的分组：将API定义导入到一个新的分组，导入过程中系统会自动创建一个新的API分组，并将导入的API归属到该分组。 选择已有分组：将API定义导入到一个已有的分组，导入过程中不会删除分组中已有的API，只是将新增的API导入分组。
域名绑定SSL证书 功能介绍 域名绑定SSL证书。目前暂时仅支持单个绑定，请求体当中的certificate_ids里面有且只能有一个证书ID。使用实例自定义入方向端口的特性时，相同的域名会同时绑定证书，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。
绑定域名 功能介绍 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
SDK有没有发布到maven仓库中？ 目前仅Java SDK已经发布到maven仓库中，maven仓库地址为https://mirrors.huaweicloud.com/repository/maven/huaweicloudsdk/com/huawei/apigateway/java-sdk-core
以便管理后端服务器节点。 如果指定名称的后端服务器组已存在，则更新对应后端服务器组信息。如果请求体中包含多个重复名称的后端服务器定义，则使用第一个定义。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{ins
操作场景 创建API前，需要先创建API分组。API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”，进入到API分组信息页面。 单击“创建分组”，弹
用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。 环境变量定义在API分组上，该分组下的所有API都可以使用这些变量。 环境变量的变量名称必须保持唯一，即一个分组在同一个环境上不能有两个同名的变量
用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。 环境变量定义在API分组上，该分组下的所有API都可以使用这些变量。 环境变量的变量名称必须保持唯一，即一个分组在同一个环境上不能有两个同名的变量。
用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。 环境变量定义在API分组上，该分组下的所有API都可以使用这些变量。 环境变量的变量名称必须保持唯一，即一个分组在同一个环境上不能有两个同名的变量
域名解绑SSL证书 功能介绍 域名解绑SSL证书。目前暂时仅支持单个解绑，请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时，相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_i
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版：SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
ffix /users/prefix-{userName} -suffix 支持 前端请求定义不支持 后端请求定义支持 /users/{proxy+} 不支持 前端请求定义支持 后端请求定义不支持 父主题： 导入导出API
范围 全部Region。 影响 自定义策略中未包含以上新增的授权项时，用户无权访问以上API。 适配方案 创建或更新自定义策略，添加以上新增的授权项以及依赖授权项，并通过给用户组授予自定义策略来进行精细的访问控制。自定义策略请参考API网关自定义策略。 父主题： 产品公告
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件，即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件，通常在gRPC中使用。它基于Protobuf语言，用于描述数据的结构和交互方式，充当客户端和服务端之间通信的合同。
操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证（APP认证或IAM认证），并选择指定的自定义认证对象，如果没有，则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端，策略条件的条件来源选择“系统参数-前端认证参
"private_key": "example" } 响应消息 表4 参数说明 名称 类型 说明 id String 自定义域名的编号 url_domain String 自定义域名 status Integer 解析状态值 ssl_id String 证书的编号 ssl_name String
拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 认证失败 401 认证失败，IAM或APP认证校验失败
需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败
绑定域名证书 功能介绍 如果创建API时，“定义API请求”使用HTTPS请求协议，那么在独立域名中需要添加SSL证书。 使用实例自定义入方向端口的特性时，相同的域名会同时绑定证书，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 本章节主要介绍为特定域名绑定证书。 调用方法
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
