检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-access-controls.policy 指定名称的访问控制策略。 如果使用该策略,需要将x-apigateway-access-control属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
default: x-apigateway-result-normal-sample: success 父主题: APIG的API设计文件扩展定义
String API的编号 api_name String API的名称 group_name String API绑定的分组 api_remark String API的描述信息 api_type Integer API类型 envname String api授权绑定的环境 auth_role
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
x-apigateway-backend.parameters 含义:API网关定义的API后端参数定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
roup_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:acl_id、api_id、 api_name、group_id、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称
-fg-body-base64 否 boolean 是否对与FunctionGraph交互场景的请求体进行Base64编码。 true:编码。 false:不编码。 父主题: APIG的API设计文件扩展定义
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
entity-type 是 String 访问控制对象,仅支持IP。 value 是 String 访问控制策略值,多个值以“,”间隔。 父主题: APIG的API设计文件扩展定义
APIG专享版支持单向认证和双向认证两种认证方式,两种认证方式开启认证的流程相同,下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名和已创建的SSL证书绑定。
acl_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:api_id、env_id、env_name、acl_id、acl_name、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选
方案描述 API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证。 单向认证:客户端与服务端连接时,客户端需要校验服务端SSl证书合法性。
> API策略”。 在“SSL证书管理”页签中,单击“创建SSL证书”。 表1 配置单向认证的证书信息 参数 配置说明 证书名称 填写证书名称,建议您按照一定的命名规则填写,方便您快速识别和查找。 可见范围 此处选择“当前实例”。 证书内容 -----Start certificate-----
新增实例的自定义入方向端口 功能介绍 新增实例的自定义入方向端口,在同个实例中,一个端口仅能支持一种协议。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @; _sys_开头属于系统标签,租户不能输入 最小长度:1 最大长度:128 values 否 Array of strings 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符:
String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role
auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String
策略条件输入来源,支持source、request。 parameter 否 String 策略条件输入来源为request时,请求入参的名称。 父主题: APIG的API设计文件扩展定义
roup_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:acl_id、api_id、 api_name、group_id、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称