检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
预先定义的函数，应用将自身的服务能力封装成API，并通过API网关开放给用户调用。 API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API分组 API分组是同一种业务API的集合，API开发者以API分组为单位，管理分组内的所有API。 环境 为了方便管理API的生
单击分组名称，进入“分组信息”页面。 在“API运行”页签，选择待调试的API，单击“调试”。 配置URL和API请求参数。 选择请求方法、请求协议、域名等，然后配置API请求参数。 域名可选调试域名或独立域名。当选择的独立域名为泛域名时，需要填写泛域名的子域名。 当独立域名为泛域名时
每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，需要为独立域名添加SSL证书。反之，跳过此步骤。 配置API的调用域名 在开放API前，您需要为API分组绑定一个独立域名，供API调用者访问API使用。
name 否 String API的名称 group_id 否 String API所属分组编号 req_protocol 否 String 请求协议 req_method 否 String 请求方法 req_uri 否 String 请求路径 auth_type 否 String 授权类型
API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式
配置APIG专享版与客户端间的单向认证或双向认证 应用场景 API前端定义中的请求协议支持HTTPS时，API所属分组在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，当SSL证书带有CA证书时，默认开启客户端认证即双向认证；反之，开启单向认证。
2：私有API version 否 String API的版本 字符长度不超过16 req_protocol 否 String API的请求协议： HTTP HTTPS BOTH：同时支持HTTP和HTTPS 默认：HTTPS req_method 是 String API的请求方式：
2：私有API version 否 String API的版本 字符长度不超过16 req_protocol 否 String API的请求协议： HTTP HTTPS BOTH：同时支持HTTP和HTTPS WEBSOCKET 默认：HTTPS req_method 是 String
API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式
共享版：已将独立域名CNAME解析到分组的子域名上，具体方法请参见增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议，那么在独立域名中需要添加SSL证书，请您提前准备SSL证书。此证书不支持导入，您需要填写证书的名称、内容和密钥。 操作步骤 进入共享版控制台。
支持http to https自动重定向 当用户的API采用http协议访问时，由于http没有传输安全与认证安全保障，可以开启自动重定向功能将API升级为安全的https协议访问，同时兼容已有的http协议。 仅当API的请求协议选择“HTTPS”或“HTTP&HTTPS”，且独立域名已
是 String API的名称 description 否 String API的描述信息 schemes 是 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义，参考表
否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义，参考表
是 String API的名称 description 否 String API的描述信息 schemes 是 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义，参考表
否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义，参考表
api_id 是 String API的编号 请求消息 表3 参数说明 名称 是否必选 类型 说明 scheme 是 String API的请求协议 HTTP HTTPS method 是 String API的请求方法 GET POST PUT DELETE HEAD PATCH OPTIONS
ingress_http_port 否 Integer 访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时，该参数未填表示用默认80端口；如果
ingress_http_port 否 Integer 访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时，该参数未填表示用默认80端口；如果
类型 说明 id String 健康检查的编号。 vpc_id String VPC通道的编号。 protocol String 使用以下协议，对VPC中主机执行健康检查。 TCP HTTP path String 健康检查时的目标路径。 说明： 需要服从URI规范。 port Integer
字典数据类型 健康检查详情，仅VPC通道类型为2时有效。 表4 健康检查详情 参数 是否必选 类型 说明 protocol 是 String 使用以下协议，对VPC中主机执行健康检查。 TCP HTTP HTTPS path protocol = http时必选 String 健康检查时的目标路径。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
