Create a Data Forwarding Flow Control Policy

Function

This API is used by an application to create a data forwarding flow control policy 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

POST /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.

Request Parameters

**Table 2** 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
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. Minimum: 1 Maximum: 256
description	No	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. Minimum: 1 Maximum: 256
scope	No	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	No	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	No	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. Minimum: 1 Maximum: 1000 Default: 1000

Response Parameters

Status code: 201

**Table 4** Response body parameters
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. Minimum: 1 Maximum: 256
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. Minimum: 1 Maximum: 256
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. Minimum: 1 Maximum: 1000 Default: 1000

Example Requests

Creates an instance-level flow control policy.

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

{
  "policy_name" : "policy_name",
  "description" : "description",
  "scope" : "USER",
  "limit" : 100
}

Creates a channel-level flow control policy.

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

{
  "policy_name" : "policy_name",
  "description" : "description",
  "scope" : "CHANNEL",
  "scope_value" : "HTTP_FORWARDING",
  "limit" : 100
}

Creates a rule-level flow control policy.

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

{
  "policy_name" : "policy_name",
  "description" : "description",
  "scope" : "RULE",
  "scope_value" : "b0443335-2627-4ebe-bdef-276113646520",
  "limit" : 100
}

Creates an action-level flow control policy.

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

{
  "policy_name" : "policy_name",
  "description" : "description",
  "scope" : "ACTION",
  "scope_value" : "b0443335-2627-4ebe-bdef-276113646520",
  "limit" : 100
}

Example Responses

Status code: 201

Created

{
  "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34",
  "policy_name" : "policyName",
  "description" : "description",
  "scope" : "CHANNEL",
  "scope_value" : "HTTP_FORWARDING",
  "limit" : 10
}