API网关 APIG-查看编排规则列表:响应参数

时间:2024-06-27 11:06:26

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

orchestrations

Array of OrchestrationBaseResp objects

本次查询到的编排规则列表。

表5 OrchestrationBaseResp

参数

参数类型

描述

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。

枚举值:

  • list

  • hash

  • range

  • hash_range

  • none_value

  • default

  • head_n

  • tail_n

orchestration_mapped_param

OrchestrationMappedParam object

编排后的参数配置,isPreprocessing为false时必填。

is_preprocessing

Boolean

是否为预处理策略,预处理策略只会生成临时参数作为后面参数编排规则的入参标记。当为预处理策略时,该编排规则不能作为除default之外的最后一个编排规则。

orchestration_id

String

编排规则编号。

orchestration_create_time

String

编排规则创建时间。

orchestration_update_time

String

编排规则更新时间。

表6 OrchestrationMappedParam

参数

参数类型

描述

mapped_param_name

String

编排后的请求参数名,只支持英文,数字,中划线,必须以英文开头,1-128个字符,不能与已有的参数重名,默认会透传到后端。

最小长度:1

最大长度:128

mapped_param_type

String

编排后的参数类型,支持string和number。

枚举值:

  • string

  • number

mapped_param_location

String

编排后的参数位置,支持query和header。

枚举值:

  • query

  • header

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

support.huaweicloud.com/api-apig/ListOrchestrations.html