文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-编排规则管理/ 更新编排规则

更新时间：2024-11-11 GMT+08:00

在线调试

CLI示例

查看PDF

更新编排规则

功能介绍

更新编排规则

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/orchestrations/{orchestration_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见获取项目ID。
instance_id	是	String	实例ID，在API网关控制台的“实例信息”中获取。
orchestration_id	是	String	编排规则编号

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
orchestration_name	是	String	编排映射规则名称。支持英文，数字，下划线，且只能以英文开头，3-64个字符，同一实例下不允许重名。最小长度：3 最大长度：64
orchestration_strategy	是	String	编排策略，有以下几种策略类型： list：列表； hash：哈希； range：区间； hash_range: 哈希+区间； none_value: 空值映射； default: 默认值映射； head_n: 截取前n项； tail_n: 截取后n项；当编排策略为list时，orchestration_map列表长度*map_param_list长度不超过3000。
orchestration_mapped_param	否	OrchestrationMappedParam object	编排后的参数配置，isPreprocessing为false时必填。
is_preprocessing	否	Boolean	是否为预处理策略，预处理策略只会生成临时参数作为后面参数编排规则的入参标记。当为预处理策略时，该编排规则不能作为除default之外的最后一个编排规则。
orchestration_map	否	Array of OrchestrationMap objects	编排映射规则列表，列表长度范围为1-300。编排映射规则的生效优先级与列表顺序保持一致，列表中靠前的配置匹配优先级较高。映射规则不能重复，当orchestration_strategy=list时，map_param_list的列表也不能包含重复元素。数组长度：1 - 300

表4 OrchestrationMappedParam
参数	是否必选	参数类型	描述
mapped_param_name	是	String	编排后的请求参数名，只支持英文，数字，中划线，必须以英文开头，1-128个字符，不能与已有的参数重名，默认会透传到后端。最小长度：1 最大长度：128
mapped_param_type	是	String	编排后的参数类型，支持string和number。
mapped_param_location	是	String	编排后的参数位置，支持query和header。

表5 OrchestrationMap
参数	是否必选	参数类型	描述
map_param_list	否	Array of strings	用于映射编排后参数的列表配置，当orchestration_strategy=list时必填，列表长度范围为0-3000。列表的取值只支持英文，数字，中划线和下划线，1-128个字符。最小长度：1 最大长度：128 数组长度：0 - 3000
map_param_range	否	OrchestrationMapParamRange object	用于映射编排后参数的区间配置，当orchestration_strategy=range或hash_range时必填。
mapped_param_value	否	String	编排后的参数取值，只支持英文和数字，1-128个字符。当orchestration_strategy为hash、head_n、tail_n，或者is_preprocessing为false时，非必填，其他情况必填。最小长度：0 最大长度：128
intercept_length	否	Integer	截取长度，取值范围为1-100，当策略类型为head_n和tail_n时必填，当截取长度大于参数长度时，截取参数的结果为完整参数。最小值：1 最大值：100

表6 OrchestrationMapParamRange
参数	是否必选	参数类型	描述
range_start	否	String	区间起始值。为可以转换成integer的string，转换后的range_start的范围为0-9223372036854775807， range_start不大于range_end。
range_end	否	String	区间终止值。为可以转换成integer的string，转换后的range_end的范围为0-9223372036854775807， range_start不大于range_end。

响应参数

状态码： 200

表7 响应Body参数
参数	参数类型	描述
orchestration_name	String	编排映射规则名称。支持英文，数字，下划线，且只能以英文开头，3-64个字符，同一实例下不允许重名。最小长度：3 最大长度：64
orchestration_strategy	String	编排策略，有以下几种策略类型： list：列表； hash：哈希； range：区间； hash_range: 哈希+区间； none_value: 空值映射； default: 默认值映射； head_n: 截取前n项； tail_n: 截取后n项；当编排策略为list时，orchestration_map列表长度*map_param_list长度不超过3000。
orchestration_mapped_param	OrchestrationMappedParam object	编排后的参数配置，isPreprocessing为false时必填。
is_preprocessing	Boolean	是否为预处理策略，预处理策略只会生成临时参数作为后面参数编排规则的入参标记。当为预处理策略时，该编排规则不能作为除default之外的最后一个编排规则。
orchestration_map	Array of OrchestrationMap objects	编排映射规则列表，列表长度范围为1-300。编排映射规则的生效优先级与列表顺序保持一致，列表中靠前的配置匹配优先级较高。映射规则不能重复，当orchestration_strategy=list时，map_param_list的列表也不能包含重复元素。数组长度：1 - 300
orchestration_id	String	编排规则编号。
orchestration_create_time	String	编排规则创建时间。
orchestration_update_time	String	编排规则更新时间。

表8 OrchestrationMappedParam
参数	参数类型	描述
mapped_param_name	String	编排后的请求参数名，只支持英文，数字，中划线，必须以英文开头，1-128个字符，不能与已有的参数重名，默认会透传到后端。最小长度：1 最大长度：128
mapped_param_type	String	编排后的参数类型，支持string和number。
mapped_param_location	String	编排后的参数位置，支持query和header。

表9 OrchestrationMap
参数	参数类型	描述
map_param_list	Array of strings	用于映射编排后参数的列表配置，当orchestration_strategy=list时必填，列表长度范围为0-3000。列表的取值只支持英文，数字，中划线和下划线，1-128个字符。最小长度：1 最大长度：128 数组长度：0 - 3000
map_param_range	OrchestrationMapParamRange object	用于映射编排后参数的区间配置，当orchestration_strategy=range或hash_range时必填。
mapped_param_value	String	编排后的参数取值，只支持英文和数字，1-128个字符。当orchestration_strategy为hash、head_n、tail_n，或者is_preprocessing为false时，非必填，其他情况必填。最小长度：0 最大长度：128
intercept_length	Integer	截取长度，取值范围为1-100，当策略类型为head_n和tail_n时必填，当截取长度大于参数长度时，截取参数的结果为完整参数。最小值：1 最大值：100

**表10** OrchestrationMapParamRange
参数	参数类型	描述
range_start	String	区间起始值。为可以转换成integer的string，转换后的range_start的范围为0-9223372036854775807， range_start不大于range_end。
range_end	String	区间终止值。为可以转换成integer的string，转换后的range_end的范围为0-9223372036854775807， range_start不大于range_end。

状态码： 400

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 401

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 403

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 404

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

更新编排规则示例。

{
  "orchestration_name" : "orchestration_demo_1",
  "orchestration_strategy" : "range",
  "orchestration_mapped_param" : {
    "mapped_param_name" : "shared-tag",
    "mapped_param_type" : "number",
    "mapped_param_location" : "header"
  },
  "orchestration_map" : [ {
    "map_param_range" : {
      "range_start" : "1",
      "range_end" : "1000"
    },
    "mapped_param_value" : "1"
  } ]
}

响应示例

状态码： 200

{
  "orchestration_id" : "yt655e81d9cb4424bf704ef2b0ac7600",
  "orchestration_name" : "orchestration_demo_1",
  "orchestration_create_time" : "2023-07-02T12:31:23.353Z",
  "orchestration_update_time" : "2023-07-02T13:31:23.353Z",
  "orchestration_strategy" : "range",
  "orchestration_mapped_param" : {
    "mapped_param_name" : "shared-tag",
    "mapped_param_type" : "number",
    "mapped_param_location" : "header"
  },
  "orchestration_map" : [ {
    "map_param_range" : {
      "range_start" : "1",
      "range_end" : "1000"
    },
    "mapped_param_value" : "1"
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:orchestration_id. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 专享版-编排规则管理

上一篇：查询编排规则详情

下一篇：删除编排规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消