检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG.API 模型说明 API提供方把API接口配置在API网关中,开放后端能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API;第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务
如何调用API 构造请求 认证鉴权 返回结果 父主题: API
APIG.ApiGroup 模型说明 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 remark 否 API分组描述 参数类型:string 取值说明:长度最大不超过
APIG.BackendApi 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 后端API的描述 取值说明:字符长度不超过255 取值约束:长度不超过255 使用建议:无 urlDomain 是 string 访问域名 取值说明:由后端服务地址和端口组成
API 如何调用API 资源栈 执行计划 模板分析 模板管理 资源栈集 自定义provider管理 资源编排-Hook 资源编排-模块管理 权限和授权项
APIG.Throttle 模型说明 流量控制可限制单位时间内API的被调用次数,保护后端服务。当API上线后,系统会默认给每个API提供一个访问控制策略,API提供者可以根据自身API的服务能力及负载情况变更这个访问控制策略。 模型属性 表1 模型定义属性说明 属性 是否必选 描述
APIG.MockInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 resultContent 否 string mock的返回结果 取值说明:mock的返回结果 取值约束:{u'max_length': 2048} 使用建议:无 父主题: 数据结构
APIG.FuncInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 描述信息 取值说明:长度不超过255个字符 取值约束:长度不超过255 使用建议:无 version 否 string 版本 取值说明:版本 使用建议:无 invocationType
什么是模板? 模板是一种遵循AOS语法规范的文本文件,描述了应用属性、云服务配置以及应用与云服务之间的依赖关系。您可以像管理代码一样来管理模板,也可像通过git、svn等代码管理工具一样来管理不同版本的模板。通过模板的方式来管理应用和云服务,可以简化应用系统上云设计,轻松复制和搭建开发
FGS.ApigEventMap 模型说明 FGS.ApigEventMap元素用来创建函数工作流服务的APIG触发器资源,APIG触发器依赖API网关服务,需预先开通APIG服务,通过APIG事件触发函数执行。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 protocol
什么是TOSCA模板? TOSCA(Topology and Orchestration Specification for Cloud Application)是开放标准联盟OASIS管理的独立技术委员会之一,其发布的云应用拓扑及编排描述规范(简称TOSCA规范)目标是规范多厂商云应用生命周期管理流程
对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。
获取执行计划 功能介绍 获取执行计划(GetExecutionPlan) 此API用于获取指定执行计划的详细内容(即执行计划项目),用户可通过此API得知指定执行计划在执行后,资源栈中的资源会发生何种变化 如果执行计划状态为CREATION_IN_PROGRESS或CREATION_FAILED
2.API调用身份认证方式 所有的API接口调用均需要经过认证的请求才可以访问成功,经过认证的请求需要包含一个签名值,该签名值以请求者的访问密钥(AK/SK)作为加密因子,结合请求体携带的特定信息计算而成。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
YAML语法 YAML 是一种简洁强大的语言,它的设计目标是便于设计和使用人员阅读。 基本语法规则 大小写敏感。 使用缩进表示层级关系。 缩进时不允许使用Tab键,只允许使用空格。 缩进的空格数目不重要,要求相同层级的元素左侧对齐。 使用#表示注释。 YAML支持三种数据结构 对象
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高
CCE.HelmRelease 模型说明 Helm是CCE提供的一种基于K8S的打包规范,CCE.HelmRelease是Helm包的部署实例。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 name 是 创建的CCE.HelmRelease名称 参数类型:string
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
get_reference get_reference是get_attribute的简化方式,当要获取到的属性信息是id或name时,将处理替换为get_attribute的refID或refName方式。 在设计器设计模板,建立多个元素之间的关系时,将自动设置get_reference