新建数据流转积压策略
功能介绍
应用服务器可调用此接口在物联网平台创建数据流转积压策略。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/routing-rule/backlog-policy
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
policy_name |
否 |
String |
参数说明：数据流转积压策略名称。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 |
description |
否 |
String |
参数说明：用户自定义的数据流转积压策略描述。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 |
backlog_size |
否 |
Integer |
参数说明：数据积压大小。单位为B（字节），取值范围为0~1073741823的整数，默认为1073741823（即1GB）。当backlog_size为0时，表示不积压。若同时配置了backlog_size和backlog_time两个维度，则以最先达到阈值的维度为准。 最小值：0 最大值：1073741823 缺省值：1073741823 |
backlog_time |
否 |
Integer |
参数说明：数据积压时间。单位为s（秒），取值范围为0~86399的整数，默认为86399（即1天）。当backlog_time为0时，表示不积压。若同时配置了backlog_size和backlog_time两个维度，则以最先达到阈值的维度为准。 最小值：0 最大值：86399 缺省值：86399 |
响应参数
状态码： 201
参数 |
参数类型 |
描述 |
|---|---|---|
policy_id |
String |
参数说明：数据流转积压策略id，用于唯一标识一个数据流转积压策略，在创建数据流转积压策略时由物联网平台分配获得。 |
policy_name |
String |
参数说明：数据流转积压策略名称。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 |
description |
String |
参数说明：用户自定义的数据流转积压策略描述。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度：1 最大长度：256 |
backlog_size |
Integer |
参数说明：数据积压大小。单位为B（字节），取值范围为0~1073741823的整数，默认为1073741823（即1GB）。当backlog_size为0时，表示不积压。若同时配置了backlog_size和backlog_time两个维度，则以最先达到阈值的维度为准。 最小值：0 最大值：1073741823 缺省值：1073741823 |
backlog_time |
Integer |
参数说明：数据积压时间。单位为s（秒），取值范围为0~86399的整数，默认为86399（即1天）。当backlog_time为0时，表示不积压。若同时配置了backlog_size和backlog_time两个维度，则以最先达到阈值的维度为准。 最小值：0 最大值：86399 缺省值：86399 |
请求示例
创建数据流转积压策略。
POST https://{endpoint}/v5/iot/{project_id}/routing-rule/backlog-policy
{
"policy_name" : "rulename",
"description" : "description",
"backlog_size" : 100,
"backlog_time" : 100
}
响应示例
状态码： 201
Created
{
"policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34",
"policy_name" : "policyName",
"description" : "description",
"backlog_size" : 1073741823,
"backlog_time" : 86399
}
状态码
状态码 |
描述 |
|---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。
