查询数据流转流控策略列表

project_id

是

String

参数说明：项目ID。获取方法请参见 获取项目ID。

scope

否

String

参数说明：流控策略作用域。不携带该参数时，查询所有作用域流控策略；取值USER时，查询租户级流控策略；取值为CHANNEL时，查询转发通道级流控策略；取值为RULE时，查询转发规则级流控策略；取值为ACTION时，查询转发动作级流控策略。

scope_value

否

String

参数说明：流控策略作用域附加值。

不携带scope参数或scope参数取值为USER时，可不携带该字段，查询租户级流控策略。

scope参数取值为CHANNEL时，不携带该字段表示查询所有转发通道级流控策略，携带该字段表示查询该字段取值对应转发通道的流控策略。取值范围：HTTP_FORWARDING、DIS_FORWARDING、OBS_FORWARDING、AMQP_FORWARDING、DMS_KAFKA_FORWARDING。

scope参数为RULE时，不携带该字段表示查询所有转发规则级流控策略，携带该字段表示查询该字段取值对应转发规则的流控策略。

scope参数为ACTION时，不携带该字段表示查询所有转发动作级流控策略，携带该字段表示查询该字段取值对应转发动作的流控策略。

policy_name

否

String

参数说明：数据流转流控策略名称。

取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

limit

否

Integer

参数说明：分页查询时每页显示的记录数。默认每页10条记录，最大设定每页50条记录。

取值范围：1-50的整数，默认值为10。

marker

否

String

参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。

取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。

offset

否

Integer

参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。 - 限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。

取值范围：0-500的整数，默认为0。

X-Auth-Token

否

String

参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

Instance-Id

否

String

参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID。

flowcontrol_policies

Array of FlowControlPolicyInfo objects

数据流转流控策略列表。

count

Integer

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

marker

String

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

policy_id

String

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

policy_name

String

参数说明：数据流转流控策略名称。

取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

description

String

参数说明：用户自定义的数据流转流控策略描述。

取值范围：长度不超过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.

200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error