计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

更新编排规则

功能介绍

更新编排规则

调用方法

请参见如何调用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

OK

{
  "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

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容