正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
instances/{instance_id}/orchestrations/{orchestration_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String
没有入参进行参数编排规则匹配,参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 id String 响应ID default Boolean 是否为分组默认响应 create_time String 创建时间
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。 使用限制 已了解前提条件。 同一个环境中一个API只能绑定一个签名密钥,一个签名密钥可以绑定多个API。 使用流程
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是
指定的API分组不存在 检查分组是否存在 404 APIG.3002 The API does not exist. 指定的API不存在 检查API是否存在 404 APIG.3003 The environment does not exist. 指定的环境不存在 检查环境是否存在 404 APIG
入分组。 API分组 仅在选择“选择已有分组”时,需要选择API分组。 是否覆盖 勾选后,当导入的API名称与已有的API名称相同时,导入的API会覆盖已有的API。 仅在选择“选择已有分组”时,需要选择是否覆盖。 扩展覆盖 勾选后,当导入API扩展定义项名称(ACL,流控等)与
请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。 同一个环境中一个API只能绑定一个签名密钥,一个签名密钥可以绑定多个API。 使用流程 在控制台创建签名密钥。
路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
on_sell_status Integer 是否已上架云商店: 1:已上架 2:未上架 3:审核中 url_domains Array of UrlDomain objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问
说明: 入参如果为boolean,请选择STRING。 必填 请求API时,此参数是否为必填。如果选择“是”,API网关将校验请求中是否包含此参数,如果不包含,则拒绝该请求。 透传 请求参数是否透传到后端服务。 默认值 “必填”为“否”时,默认值生效。请求中不包含此参数时,API网关自动增加默认值发送给后端服务。
on_sell_status Integer 是否已上架云商店: 1:已上架 2:未上架 3:审核中 url_domains Array of UrlDomain objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组 APIG.0101 The API does not
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The API does not
对于简单请求,浏览器自动在头信息之中,添加一个Origin字段,Origin字段用于说明本次请求来自哪个源(协议+域名+端口)。服务器根据这个值,决定是否同意这次请求。服务器响应消息中包含“Access-Control-Allow-Origin”时,表示同意请求。 非简单请求 不满足简单请求两个条件的都为非简单请求。
info参数说明 名称 是否必选 参数类型 说明 title 是 String API分组名称 version 是 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表6 paths参数说明 名称 是否必选 参数类型 说明
info参数说明 名称 是否必选 参数类型 说明 title 是 String API分组名称 version 是 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表6 paths参数说明 名称 是否必选 参数类型 说明
info参数说明 名称 是否必选 参数类型 说明 title 是 String API分组名称 version 是 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表5 paths参数说明 名称 是否必选 参数类型 说明
info参数说明 名称 是否必选 参数类型 说明 title 是 String API分组名称 version 是 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表5 paths参数说明 名称 是否必选 参数类型 说明
参数 参数位置 是否必选 类型 说明 extend_mode query 否 String 扩展信息导入模式,可选merge和override。 当扩展信息定义冲突时,merge保留原有扩展信息,override会覆盖原有扩展信息。 请求消息 表3 参数说明 名称 是否必选 参数类型