检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
说明: 中文字符必须为UTF-8或者unicode编码。 最大长度:255 create_time String 创建时间。 update_time String 更新时间。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
说明: 中文字符必须为UTF-8或者unicode编码。 最大长度:255 create_time String 创建时间。 update_time String 更新时间。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
获取账号名和账号名ID 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下: 登录管理控制台。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 查看账号名和账号ID。 父主题: 附录
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API为APP认证时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。
创建API分组 操作场景 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头
专享版-APP授权管理 APP授权 解除授权 查看APP已绑定的API列表 查看APP未绑定的API列表 查看API已绑定的APP列表 父主题: 专享版API(V2)
专享版-凭据配额管理 创建凭据配额 获取凭据配额详情 获取凭据配额列表 修改凭据配额 删除凭据配额 查询凭据配额已绑定的凭据列表 凭据配额绑定凭据列表 解除凭据配额和凭据的绑定 查询凭据配额可绑定的凭据列表 父主题: 专享版API(V2)
API绑定ACL策略(待下线) 对象模型 将API与ACL策略进行绑定 查看API绑定的ACL策略列表 查看ACL策略绑定的API列表 查看ACL策略未绑定的API列表 解除API与ACL策略的绑定 批量解除API与ACL策略的绑定 父主题: 专享版API(V1)(待下线)
APP授权管理 对象模型 查看APP未绑定的API列表 授权 查看APP已绑定的API列表 查看API已绑定的APP列表 解除授权 父主题: 共享版API(仅存量用户使用)
APP授权管理(待下线) 对象模型 查看APP未绑定的API列表 授权 查看APP已绑定的API列表 查看API已绑定的APP列表 解除授权 父主题: 专享版API(V1)(待下线)
API绑定流控策略 对象模型 查看流控策略未绑定的API列表 绑定流控策略 查看流控策略绑定的API列表 查看API绑定的流控策略列表 解除绑定 父主题: 共享版API(仅存量用户使用)
签名密钥绑定关系管理(待下线) 对象模型 查看签名密钥未绑定的API列表 绑定签名密钥 查看签名密钥绑定的API列表 查看API绑定的签名密钥列表 解除绑定 父主题: 专享版API(V1)(待下线)