检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String VPC通道的编号。 inst_id 是 String 后端实例对象的编号。 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content 400 Bad Request
PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间 响应消息样例: { "id": "d402b35e-1
全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果。
PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间 响应消息样例: { "id": "d402b35e-1
acl_type 否 String 类型 PERMIT (白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3
可通过开启公网入口与出口访问,允许外部服务调用API,及后端部署在外部网络环境中。 云商店售卖 API可在云商店公开售卖。 不支持将API上架到云商店公开售卖。 使用对象 小型用户。 物理隔离要求较低,能够开箱即用,快速实现API能力开放。 中大型用户。 专享版API网关拥有物理隔离的独立集群, 更丰富的特性。
策略条件列表 authorizer_id 否 String 后端自定义认证对象的ID 表10 BackendApiCreate 参数 是否必选 参数类型 描述 authorizer_id 否 String 后端自定义认证对象的ID url_domain 否 String 后端服务的地址。后端服务不使用VPC通道时,参数必选
Swagger或OpenAPI文件。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 OpenAPI版本
entity_type为DOMAIN_ID时,策略值需填写账号ID,获取方式请参见API参考的“附录 > 获取账号ID”章节。 entity_type 是 String 对象类型: IP:IP地址 DOMAIN:账号名 DOMAIN_ID:账号ID 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
VPC通道的创建时间。 表5 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 后端实例的名称。 instance_id
定的编排规则中存在 id String 编号 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表17 VpcInfo 参数 参数类型 描述 ecs_id String 云服务器ID ecs_name
API的ID $context.apiName API名称 $context.appId API调用者的凭据对象ID $context.appName API调用者的凭据对象名称 $context.requestId 当次API调用生成请求ID $context.stage API调用的部署环境
secrets = new HashMap<>(); static { // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全; // 本示例以ak和sk保存在环境变量中
VPC通道的创建时间。 表5 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 后端实例的名称。 instance_id
定的编排规则中存在 id String 编号 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表17 VpcInfo 参数 参数类型 描述 ecs_id String 云服务器ID ecs_name
命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期(原始指标) avg_latency 平均延迟毫秒数 该指标用于统计测量api接口平均响应延时时间 ≥0 单位:毫秒 单个API
策略条件列表 authorizer_id 否 String 后端自定义认证对象的ID 表10 BackendApiCreate 参数 是否必选 参数类型 描述 authorizer_id 否 String 后端自定义认证对象的ID url_domain 否 String 后端服务的地址。后端服务不使用VPC通道时,参数必选
(白名单类型) DENY (黑名单类型) acl_value String ACL策略值 entity_type String ACL策略作用的对象类型: IP DOMAIN ADMIN env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id
策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明 app_code_auth_type
实例ID,在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号 member_id 是 String 后端实例对象的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。