检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 如何调用API 资源栈 执行计划 模板分析 模板管理 资源栈集 自定义provider管理 资源编排-Hook 资源编排-模块管理 权限和授权项
FGS.ApigEventMap 模型说明 FGS.ApigEventMap元素用来创建函数工作流服务的APIG触发器资源,APIG触发器依赖API网关服务,需预先开通APIG服务,通过APIG事件触发函数执行。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 protocol
APIG.BackendApi 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 后端API的描述 取值说明:字符长度不超过255 取值约束:长度不超过255 使用建议:无 urlDomain 是 string 访问域名 取值说明:由后端服务地址和端口组成,总长度不超过255
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 取值说明:长度最大不超过255个字符
APIG.Throttle 模型说明 流量控制可限制单位时间内API的被调用次数,保护后端服务。当API上线后,系统会默认给每个API提供一个访问控制策略,API提供者可以根据自身API的服务能力及负载情况变更这个访问控制策略。 模型属性 表1 模型定义属性说明 属性 是否必选 描述
若hook_name和hook_id同时存在,则资源编排服务会检查两个是否匹配,如果不匹配则会返回400。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/priv
APIG.MockInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 resultContent 否 string mock的返回结果 取值说明:mock的返回结果 取值约束:{u'max_length': 2048} 使用建议:无 父主题: 数据结构
APIG.FuncInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 描述信息 取值说明:长度不超过255个字符 取值约束:长度不超过255 使用建议:无 version 否 string 版本 取值说明:版本 使用建议:无 invocationType
如果module_name和module_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/priv
获取资源栈实例(ShowStackInstance) 用户可以使用此API获取资源栈实例的详细信息,包括关联资源栈名称与id,创建时间,参数覆盖等 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
eHook API删除,除默认版本外的其它版本都可以调用本API删除。 若hook_name和hook_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。 请谨慎操作 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explo
D) 回滚失败(ROLLBACK_FAILED) 删除失败(DELETION_FAILED) 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PATCH /v1/{p
中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到
请谨慎操作,删除私有hook将会删除该私有hook和该私有hook下的所有私有hook版本。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/p
后调用ApplyExecutionPlan部署资源栈。 调用DeployStack部署资源栈 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/{
如果不匹配则会返回400。 请谨慎操作,删除私有模块将会删除该私有模块下的所有的模块版本。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/p
继续部署操作依然有可能部署失败,用户可以从ListStackEvents获取对应的log,解决后可再次调用此API触发继续部署 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST
如果执行计划状态处于CREATION_IN_PROGRESS、APPLY_IN_PROGRESS状态时,则不允许删除并返回403 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/{