检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果 父主题: API
APIG.API 模型说明 API提供方把API接口配置在API网关中,开放后端能力。API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API;第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
API 如何调用API 资源栈 执行计划 模板分析 模板管理 资源栈集 自定义provider管理 资源编排-Hook 资源编排-模块管理 权限和授权项
APIG.ApiGroup 模型说明 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 remark 否 API分组描述 参数类型:string 取值说明:长度最大不超过255个字符
APIG.BackendApi 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 后端API的描述 取值说明:字符长度不超过255 取值约束:长度不超过255 使用建议:无 urlDomain 是 string 访问域名 取值说明:由后端服务地址和端口组成,总长度不超过255
FGS.ApigEventMap 模型说明 FGS.ApigEventMap元素用来创建函数工作流服务的APIG触发器资源,APIG触发器依赖API网关服务,需预先开通APIG服务,通过APIG事件触发函数执行。 模型属性 表1 模型定义属性说明 属性 是否必选 描述 protocol
APIG.FuncInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 remark 否 string 描述信息 取值说明:长度不超过255个字符 取值约束:长度不超过255 使用建议:无 version 否 string 版本 取值说明:版本 使用建议:无 invocationType
APIG.Throttle 模型说明 流量控制可限制单位时间内API的被调用次数,保护后端服务。当API上线后,系统会默认给每个API提供一个访问控制策略,API提供者可以根据自身API的服务能力及负载情况变更这个访问控制策略。 模型属性 表1 模型定义属性说明 属性 是否必选 描述
APIG.MockInfo 字段说明 表1 字段说明 属性 是否必选 参数类型 描述 resultContent 否 string mock的返回结果 取值说明:mock的返回结果 取值约束:{u'max_length': 2048} 使用建议:无 父主题: 数据结构
) 此API用于获取指定执行计划的详细内容(即执行计划项目),用户可通过此API得知指定执行计划在执行后,资源栈中的资源会发生何种变化 如果执行计划状态为CREATION_IN_PROGRESS或CREATION_FAILED,则不返回执行计划项目列表 调试 您可以在API Ex
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
onseBody。 如果需要获取执行计划的具体内容,请调用GetExecutionPlan。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{pro
huaweicloud_drs_job: 支持的计费模式:按需 huaweicloud_apig_instance: 支持的计费模式:按需 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
正在删除(DELETION_IN_PROGRESS) 正在回滚(ROLLBACK_IN_PROGRESS) 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/{pr
y),如果用户需要详细的执行计划元数据请调用GetExecutionPlanMetadata 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{pro
执行计划 列举执行计划 创建执行计划 获取执行计划 执行执行计划 删除执行计划 获取执行计划元数据 预估执行计划价格 父主题: API
ESS、DELETION_IN_PROGRESS等状态时,则不允许创建执行计划,并返回403 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/{pr
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
如果执行计划状态处于CREATION_IN_PROGRESS、APPLY_IN_PROGRESS状态时,则不允许删除并返回403 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/{