检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在“API运行”页签,选择待调试的API,单击“调试”。 配置URL和API请求参数。 选择请求方法、请求协议、域名等,然后配置API请求参数。 域名可选调试域名或独立域名。当选择的独立域名为泛域名时,需要填写泛域名的子域名。 当独立域名为泛域名时,用户可以通过泛域名的所有子域名访问所绑定分组下的所有API。
在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。系统自动分配的域名不能用于生产业务,且仅限应用程序调试使用。 创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。
否 Array of TmsMatchesKeyValue objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表5 TmsKeyValues
证方式,两种认证方式开启认证的流程相同,下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名和已创建的SSL证书绑定。 调用API 验证API是否调用成功。
密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI POST /v2/{project
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
String 需要进行的操作。 online:发布 offline:下线 env_id 是 String 环境的编号,即:API需要发布到哪个环境 api_id 是 String API的编号,即:需要进行发布或下线的API的编号 remark 否 String 对发布动作的简述。字符长度不超过255
String API版本的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer
req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project_i
API绑定插件 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project_i
查询插件列表 功能介绍 查询一组符合条件的API网关插件详情。 支持分页 支持根据插件类型查询 支持根据插件可见范围查询 支持根据插件编码查询 支持根据名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances
String API版本的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer
run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API发布记录编号 acl_name String 绑定的其他同类型的ACL策略名称 req_uri String API的访问地址 auth_type String
req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String
说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance 仅VPC通道类型为2时有效。
说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance 仅VPC通道类型为2时有效。
group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name
APIG对API请求体的大小是否有限制? 共享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,API网关会拒绝该请求。这种场景,推荐考虑使用对象存储服务。 专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,
certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数