检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
E环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage: Develop”。 创建环境变量 进入API网关控制台页面。
请求消息 表2 参数说明 名称 是否必选 类型 说明 id 否 String 签名密钥编号 name 否 String 签名密钥名称 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明
查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边显示“当前版本”,说明设置成功。 API调用者调用此API时,API参数为“当前版本”设
API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面,单击“更多 > 克隆”。 根据下表参数说明,自定义API名称和API前端路径,单击“确定”。 表1 克隆API配置 参数 说明 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。
paths: '/path': get: x-apigateway-request-type: 'public' 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-request-type 是 String API类型,支持public和private。
页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号
IAM 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-auth-type 是 String API网关认证方式,支持AppSigv1、IAM。 type 是 String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in
x-apigateway-backend: type: "backend endpoint type" 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-backend 是 String API后端服务定义。 type 是 String
所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps 请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。
Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持variable_name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 variables 字典数据类型 本次返回的环境变量列表 total Integer
表1 HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/acl-bindings 请求消息 表2 参数说明 参数 类型 说明 acl_id String ACL策略编号 publish_ids []String API发布记录编号 请求消息样例:
指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明 参数 类型 说明
指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明 参数 类型 说明
/v1/{project_id}/apigw/instances/{instance_id}/env-variables URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
/v1/{project_id}/apigw/instances/{instance_id}/throttle-bindings URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
/v1/{project_id}/apigw/instances/{instance_id}/throttle-specials URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号
查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边显示“当前版本”,说明设置成功。 API调用者调用此API时,API参数为“当前版本”设
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
"MOCK" mockEndpoints: result-content: "mocked" 表1 参数说明 参数 是否必选 类型 说明 result-content 是 String MOCK返回结果。 父主题: APIG的API设计文件扩展定义