检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果 父主题: API
APIG.API 模型说明 API提供方把API接口配置在API网关中,开放后端能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API;第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务
APIG.BackendApi 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 后端API的描述 取值说明:字符长度不超过255 取值约束:长度不超过255 使用建议:无 urlDomain 是 string 访问域名 取值说明:由后端服务地址和端口组成
APIG.ApiGroup 模型说明 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 remark 否 API分组描述 参数类型:string 取值说明:长度最大不超过
APIG.Throttle 模型说明 流量控制可限制单位时间内API的被调用次数,保护后端服务。当API上线后,系统会默认给每个API提供一个访问控制策略,API提供者可以根据自身API的服务能力及负载情况变更这个访问控制策略。 模型属性 表1 模型定义属性说明 属性 是否必选 描述
API 如何调用API 资源栈 执行计划 模板分析 模板管理 资源栈集 自定义provider管理 资源编排-Hook 资源编排-模块管理 权限和授权项
APIG.FuncInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 描述信息 取值说明:长度不超过255个字符 取值约束:长度不超过255 使用建议:无 version 否 string 版本 取值说明:版本 使用建议:无 invocationType
FGS.ApigEventMap 模型说明 FGS.ApigEventMap元素用来创建函数工作流服务的APIG触发器资源,APIG触发器依赖API网关服务,需预先开通APIG服务,通过APIG事件触发函数执行。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 protocol
APIG.MockInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 resultContent 否 string mock的返回结果 取值说明:mock的返回结果 取值约束:{u'max_length': 2048} 使用建议:无 父主题: 数据结构
2.API调用身份认证方式 所有的API接口调用均需要经过认证的请求才可以访问成功,经过认证的请求需要包含一个签名值,该签名值以请求者的访问密钥(AK/SK)作为加密因子,结合请求体携带的特定信息计算而成。
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
异常 堆栈运行异常,堆栈下某些或全部实例运行异常,异常的实例对外提供功能障碍。 初始化 堆栈下实例尚未被安装或已被卸载,堆栈不对外提供功能。 处理中 堆栈正在被执行生命周期,堆栈下实例状态不确定。 未知错误 堆栈发生未知错误。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。
解析模板参数 功能介绍 解析模板参数(ParseTemplateVariables) 此API用于解析用户输入的模板中的参数(variable),将解析模板中的所有variable块并返回 如果用户传入的模板中定义了variable参数,则返回200和所有variable 如果用户传入的模板中没有定义
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高
模板分析 解析模板参数 父主题: API
资源栈集 列举资源栈集 创建资源栈集 获取资源栈集模板 列举资源栈集操作 获取资源栈集元数据 列举资源栈实例 创建资源栈实例 删除资源栈实例-已废弃 更新资源栈实例 删除资源栈实例 部署资源栈集 删除资源栈集 更新资源栈集 获取资源栈集操作的元数据 获取资源栈实例 父主题: API
删除模板 功能介绍 删除模板(DeleteTemplate) 此API用于删除某个模板以及模板下的全部模板版本 请谨慎操作,删除模板将会删除模板下的所有模板版本。 template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一
自定义provider管理 创建私有provider 创建私有provider版本 父主题: API