检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改插件 功能介绍 修改插件信息。 插件不允许重名 插件不支持修改类型和可见范围 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
参数 参数类型 描述 acl_bindings Array of AclApiBindingInfo objects API与ACL的绑定关系列表 表5 AclApiBindingInfo 参数 参数类型 描述 id String 绑定关系编号 api_id String API编号
能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
ba36-9f0bc6f22057" ] } 响应消息 表4 参数说明 名称 类型 说明 - 字典数据类型 API与签名密钥的绑定关系列表 表5 字典类型响应参数 名称 类型 说明 id String 绑定关系的ID api_id String API编号 api_name String
offline:下线 请求消息 表3 参数说明 参数 是否必选 类型 说明 apis 是 String Array 需要发布或下线的API ID列表 env_id 是 String 环境ID remark 否 String 对本次发布的描述信息 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。
instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String APP的编号,可通过查询APP列表获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3
创建插件 功能介绍 创建插件信息。 插件不允许重名 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/plugins
单击“确定”,完成密钥的创建。 绑定API 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 通过以下任意一种方法,查看签名密钥已绑定API列表页面。 在待绑定API的密钥所在行,单击“绑定API”,进入“签名密钥绑定API”页面。 单击待绑定API的密钥名称,进入密钥详情页面。
当您的API后端服务部署在公网时,除实例费用外需要另外收取API请求出公网带宽费用。 专享版实例部署在虚拟私有云中,如果您的后端服务也部署在相同虚拟私有云,可直接通过私有地址访问,无需购买带宽。 专享版实例的API如从公网调用,实例需绑定一个弹性公网IP,作为公网入口。弹性公网IP需要单独购买。 专享版实例的A
offline:下线 请求消息 表3 参数说明 参数 是否必选 类型 说明 apis 是 String Array 需要发布或下线的API ID列表 env_id 是 String 环境ID remark 否 String 对本次发布的描述信息 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。
表1 应用信息 信息项 描述 应用名称 应用名称。 描述 对应用的介绍。 单击“确定”,创建应用。 创建应用成功后,在“应用管理”页面的列表中显示新创建的应用和应用ID。 单击应用名称,进入应用详情页面,查看AppKey和AppSecret。 图1 应用详情 绑定API 进入共享版控制台。
式的APIG实例,单击操作列“更多 > 到期转按需”。 批量资源到期转按需:在“手动续费项”页签中选择需要更改计费模式的APIG实例,单击列表左上角的“到期转按需”。 单击“到期转按需项”页签,可查看计费模式变更后的相关信息。 父主题: 变更计费模式
)。 表4 请求Body参数 参数 是否必选 参数类型 描述 apis 否 Array of strings 需要发布或下线的API ID列表,单次更新上限为1000个API。必须指定apis或group_id。 env_id 是 String 环境ID group_id 否 String
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
200 表4 响应Body参数 参数 参数类型 描述 datapoints Array of MetricData objects 指标数据列表 表5 MetricData 参数 参数类型 描述 average Integer 聚合周期内指标数据的平均值,仅当请求参数filter字段值为average时支持。
VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。 单击“编辑”,弹出“编辑健康检查配置”对话框。
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
开放API 无法创建API是什么原因? API的响应码如何定义? API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? APIG是否支持多后端节点方案? API可以绑定内网域名吗? 为什么跨域调用API失败? API网关如何开放部署在华为云上的服务?
表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-
选择API授权环境,查询并勾选应用后,单击“授权”。 授权成功后,可以在“授权信息”/“授权API”中查看已授权的应用。 如果已授权的应用列表中包含无需授权的应用,在此应用所在行单击“解除授权”,将无需授权的应用删除。 后续操作 您将API授权给指定应用后,可以通过不同语言的SDK调用此API。