检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果 父主题： API
API 如何调用API 资源栈 执行计划 模板分析 模板管理 资源栈集 自定义provider管理 资源编排-Hook 资源编排-模块管理 权限和授权项
APIG.API 模型说明 API提供方把API接口配置在API网关中，开放后端能力。API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API；第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。
APIG.ApiGroup 模型说明 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 remark 否 API分组描述 参数类型：string 取值说明：长度最大不超过255个字符
APIG.BackendApi 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 后端API的描述 取值说明：字符长度不超过255 取值约束：长度不超过255 使用建议：无 urlDomain 是 string 访问域名 取值说明：由后端服务地址和端口组成，总长度不超过255
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
回滚完成（ROLLBACK_COMPLETE） 删除失败（DELETION_FAILED） 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{pro
更新模板元数据 功能介绍 更新模板元数据（UpdateTemplateMetadata） 此API用于更新模板元数据 此api只支持更新模板描述 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
模板管理 列举模板 删除模板 更新模板元数据 获取模板元数据 列举模板版本 删除模板版本 获取模板版本内容 获取模板版本元数据 父主题： API
FGS.ApigEventMap 模型说明 FGS.ApigEventMap元素用来创建函数工作流服务的APIG触发器资源，APIG触发器依赖API网关服务，需预先开通APIG服务，通过APIG事件触发函数执行。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 protocol
获取资源栈模板 功能介绍 获取资源栈模板（GetStackTemplate） 此API用于获取资源栈最近一次部署终态使用的模板。 注： 当资源栈状态处于非终态（即以IN_PROGRESS结尾，详细见下方）状态时，资源栈处于转变阶段，此API获取资源栈上一次部署使用的模板。 只有当
获取资源栈实例 功能介绍 获取资源栈实例（ShowStackInstance） 用户可以使用此API获取资源栈实例的详细信息，包括关联资源栈名称与id，创建时间，参数覆盖等 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。
获取资源栈模板 列举资源栈资源 列举资源栈输出 继续部署资源栈 部署资源栈 删除资源栈 更新资源栈 条件删除资源栈 继续回滚资源栈 父主题： API
D） 回滚失败（ROLLBACK_FAILED） 删除失败（DELETION_FAILED） 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PATCH /v1/{p
板版本，请调用DeleteTemplate。模板服务不允许存在没有模板版本的模板 请谨慎操作 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v1/{
调用ApplyExecutionPlan部署资源栈。 调用DeployStack部署资源栈。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v1/{pr
部署资源栈 功能介绍 部署资源栈（DeployStack） 此API用于部署一个已有的资源栈 用户可以使用此API更新模板、参数等并触发一个新的部署 此API会直接触发部署，如果用户希望先确认部署会发生的时间，请使用执行计划，即使用CreateExecutionPlan以创建执行
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
