检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果 父主题: API
资源索引 服务 元素 元素说明 流量清洗 AntiDDos.Service 一种流量清洗服务,可对EIP预防DDos攻击。 应用编排服务 AOS.Batch Batch是一个批处理对象,用于批量创建执行任务、部署等。Batch通过定义包含的子对象及批处理的次数来实现其批量化处理的功能
列举资源栈资源 功能介绍 列举资源栈资源(ListStackResources) 此API用于列举资源栈中当前管理的所有资源的信息 当资源栈处于非终态时,仅输出资源栈下资源的简要信息,包含逻辑资源名称(logical_resource_name),逻辑资源类型(logical_resource_type
解析模板参数 功能介绍 解析模板参数(ParseTemplateVariables) 此API用于解析用户输入的模板中的参数(variable),将解析模板中的所有variable块并返回 如果用户传入的模板中定义了variable参数,则返回200和所有variable 如果用户传入的模板中没有定义
APIG.API 模型说明 API提供方把API接口配置在API网关中,开放后端能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API;第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务
列举资源栈事件 功能介绍 列举资源栈事件(ListStackEvents) 此API用于列举资源栈某一次或全部的部署事件 如果给予deployment_id,则会将deployment_id作为查询条件,返回对应某一次部署的资源栈事件;如果不给予deployment_id,则返回全量的资源栈事件
部署资源栈 功能介绍 部署资源栈(DeployStack) 此API用于部署一个已有的资源栈 用户可以使用此API更新模板、参数等并触发一个新的部署 此API会直接触发部署,如果用户希望先确认部署会发生的时间,请使用执行计划,即使用CreateExecutionPlan以创建执行计划
创建私有provider 功能介绍 创建私有provider(CreatePrivateProvider) 创建一个私有的空provider。如果用户给予了provider_version和function_graph_urn,则在创建私有provider的同时,还会在私有provider
获取执行计划 功能介绍 获取执行计划(GetExecutionPlan) 此API用于获取指定执行计划的详细内容(即执行计划项目),用户可通过此API得知指定执行计划在执行后,资源栈中的资源会发生何种变化 如果执行计划状态为CREATION_IN_PROGRESS或CREATION_FAILED
获取资源栈元数据 功能介绍 获取资源栈元数据(GetStackMetadata) 此API用于获取指定资源栈的元数据,包括资源栈ID、资源栈名称、资源栈描述、创建时间、更新时间、资源栈状态、委托授权等信息。 具体信息见GetStackMetadataResponseBody。 注:
获取执行计划元数据 功能介绍 获取执行计划元数据(GetExecutionPlanMetadata) 该API可以获取指定执行计划的元数据,包括资源栈ID、资源栈名称、执行计划ID、执行计划名称、执行计划描述、执行计划的创建时间和执行时间、执行计划状态等信息。 具体信息见GetExecutionPlanMetadataResponseBody
创建资源栈 功能介绍 CreateStack用于生成一个资源栈 当请求中不含有模板(template)、参数(vars)等信息,将生成一个无任何资源的空资源栈,返回资源栈ID(stack_id) 当请求中携带了模板(template)、参数(vars)等信息,则会同时创建并部署资源栈
预估执行计划价格 功能介绍 预估执行计划价格(EstimateExecutionPlanPrice) 此API可以基于一份已有的执行计划中增量的资源进行询价,当前支持询价的计费模式有包周期计费、按需计费、免费,暂不支持其他形式的计费模式,例如竞价计费模式等。 注: 由于某些资源的属性值含有默认值
创建执行计划 功能介绍 创建执行计划(CreateExecutionPlan) 此API用于在指定的资源栈下生成一个执行计划,执行计划描述了当前资源栈中记录的资源状态和模板描述的目的资源状态之间的区别(如,资源A将以以下配置文件生成,资源B将以下参数从XXX修改成YYY) 调用此API
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 RF.10011001 Missing required parameter(s). 缺少必要参数
MRS.Cluster 模型说明 MRS是一个在华为云上部署和管理Hadoop系统的服务,一键即可部署Hadoop集群。通过MRS.Cluster创建集群,您可指定集群类型用于离线数据分析和流处理任务,也可指定集群中预置的弹性云服务器实例规格、实例数量、数据盘类型(普通IO、高 IO
FGS.ApigEventMap 模型说明 FGS.ApigEventMap元素用来创建函数工作流服务的APIG触发器资源,APIG触发器依赖API网关服务,需预先开通APIG服务,通过APIG事件触发函数执行。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 protocol
应用编排错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个 4xx 或 5xx 的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题