Query a List of Data Forwarding Flow Control Policies

Function

This API is used by an application to query a list of data forwarding flow control policies configured on the IoT platform.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v5/iot/{project_id}/routing-rule/flowcontrol-policy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
scope	No	String	Parameter description: Scope of a flow control policy. If this parameter is not carried, flow control policies in all scopes are queried. If this parameter is set to USER, tenant-level flow control policies are queried. If this parameter is set to CHANNEL, forwarding channel-level flow control policies are queried. If this parameter is set to RULE, forwarding rule-level flow control policies are queried. If this parameter is set to ACTION, the forwarding action-level flow control policy is queried.
scope_value	No	String	Parameter description: Additional value of the flow control policy scope. If scope is not specified or is set to USER, this parameter can be left empty to query tenant-level flow control policies. If scope is set to CHANNEL and this parameter is not carried, the policies applied to all forwarding channels are queried. If this parameter is carried, the policy applied to the specified channel is queried. Value range: HTTP_FORWARDING, DIS_FORWARDING, OBS_FORWARDING, AMQP_FORWARDING, and DMS_KAFKA_FORWARDING. If scope is set to RULE and this parameter is not carried, the policies applied to all forwarding rules are queried. If this parameter is carried, the policy applied to the specified rule is queried. If scope is set to ACTION and this parameter is not carried, the policies applied to all forwarding actions are queried. If this parameter is carried, the policy applied to the specified action is queried.
policy_name	No	String	Parameter description: Name of a data flow control policy. Value: The value can contain a maximum of 256 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed.
limit	No	Integer	Parameter description: Number of records to display on each page. By default, 10 records are displayed on each page. A maximum of 50 records can be displayed on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value is a string of 24 hexadecimal characters. The default value is ffffffffffffffffffffffff.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. The value is an integer ranging from 0 to 500. The default value is 0. If offset is set to 0, the output starts from the first record after the last record in the previous query. - To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: Instance ID. This parameter is required only when the API is called from the management plane in the physical multi-tenant scenario. You can log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
flowcontrol_policies	Array of FlowControlPolicyInfo objects	List of data forwarding flow control policies.
count	Integer	Total number of records that meet the filter criteria.
marker	String	ID of the last record in this query, which can be used in the next query.

**Table 5** FlowControlPolicyInfo
Parameter	Type	Description
policy_id	String	Parameter description: ID of the flow control policy. The value of this parameter is unique and is allocated by the platform during policy creation.
policy_name	String	Parameter description: Name of a data flow control policy. Value: The value can contain a maximum of 256 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed.
description	String	Parameter description: Description of a custom data transfer flow control policy. Value: The value can contain a maximum of 256 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed.
scope	String	Parameter description: Scope of a flow control policy. Options: USER: tenant-level flow control policy CHANNEL: forwarding channel-level flow control policy RULE: forwarding rule-level flow control policy ACTION: forwarding action-level flow control policy
scope_value	String	Parameter description: Additional value of the flow control policy scope. If scope is set to USER, this parameter is optional, indicating tenant-level flow control. If scope is set to CHANNEL, this parameter can be set to HTTP_FORWARDING, DIS_FORWARDING, OBS_FORWARDING, AMQP_FORWARDING, or DMS_KAFKA_FORWARDING. If scope is set to RULE, set this parameter to the corresponding rule ID. If scope is set to ACTION, set this parameter to the corresponding action ID.
limit	Integer	Parameter description: Flow control size for data forwarding. The value is an integer ranging from 1 to 1000, in TPS. The default value is 1000.

Example Requests

Queries the flow control policy list.

GET https://{endpoint}/v5/iot/{project_id}/routing-rule/flowcontrol-policy

Example Responses

Status code: 200

{
  "flowcontrol_policies" : [ {
    "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34",
    "policy_name" : "policyName",
    "description" : "description",
    "scope" : "CHANNEL",
    "scope_value" : "HTTP_FORWARDING",
    "limit" : 10
  } ],
  "count" : 10,
  "marker" : "5c90fa7d3c4e4405e8525079"
}