设备接入 IOTDA-查询数据流转流控策略列表:响应参数

时间:2024-06-28 09:24:45

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

flowcontrol_policies

Array of FlowControlPolicyInfo objects

数据流转流控策略列表。

数组长度:0 - 50

count

Integer

满足查询条件的记录总数。

marker

String

本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用。

表5 FlowControlPolicyInfo

参数

参数类型

描述

policy_id

String

参数说明:数据流转流控策略id,用于唯一标识一个数据流转流控策略,在创建数据流转流控策略时由 物联网平台 分配获得。

policy_name

String

参数说明:数据流转流控策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

最小长度:1

最大长度:256

description

String

参数说明:用户自定义的数据流转流控策略描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

最小长度:1

最大长度:256

scope

String

参数说明:流控策略作用域. 取值范围

  • USER:租户级流控策略。

  • CHANNEL:转发通道级流控策略。

  • RULE:转发规则级流控策略。

  • ACTION:转发动作级流控策略。

scope_value

String

参数说明:流控策略作用域附加值。 scope取值为USER时,可不携带该字段,表示租户级流控。 scope取值为CHANNEL时,取值范围:HTTP_FORWARDING、DIS_FORWARDING、OBS_FORWARDING、AMQP_FORWARDING、DMS_KAFKA_FORWARDING。 scope取值为RULE时,该字段为对应的ruleId。 scope取值为ACTION时,该字段为对应的actionId。

limit

Integer

参数说明:数据转发流控大小。单位为tps,取值范围为1~1000的整数,默认为1000.

最小值:1

最大值:1000

缺省值:1000

support.huaweicloud.com/api-iothub/ListRoutingFlowControlPolicy.html