检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
define 否 String 导出API的定义范围： base：基础定义 full：全量定义 all：扩展定义 默认为base version 否 String 导出的API定义版本，默认为当前时间 type 否 String 导出的API定义的格式：json/yaml，默认为json
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义
define 否 String 导出API的定义范围： base：基础定义 full：全量定义 all：扩展定义 默认为base version 否 String 导出的API定义版本，默认为当前时间 type 否 String 导出的API定义的格式：json/yaml，默认为json
定义参数 定义用于规则的参数。建议不要设置敏感信息，以防泄露。 参数位置：用于规则匹配的参数位置。 path：API请求的URI，系统默认配置。 method：API请求方法，系统默认配置。 header：请求头的key值。 query：QueryString的key值。 system：系统参数。
String 策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数，
0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型： FRONTEND：前端
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。
添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型：传统的HTTP
添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型：传统的HTTP
String 策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明 app_code_auth_type
String 策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明 app_code_auth_type
添加或更新后端实例 功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在，则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义，则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST
String 策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。
例信息中获取。 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
