Updated on 2024-06-27 GMT+08:00

Modify a Data Transfer Stacking Policy

Function

This API is used by an application to modify a specified data transfer and stacking 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

PUT /v5/iot/{project_id}/routing-rule/backlog-policy/{policy_id}

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.

policy_id

Yes

String

Parameter description: ID of the data stacking policy. The value of this parameter is unique and is allocated by the platform during data stacking policy creation.

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 transfer stacking 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 stacking policy. Value: The value can contain a maximum of 256 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed.

Minimum: 1

Maximum: 256

backlog_size

No

Integer

Parameter description: Size of stacked data. The value is an integer ranging from 0 to 1073741823, in bytes. The default value is 1073741823 (1 GB). If the value of backlog_size is 0, logs are not stacked. If both backlog_size and backlog_time are configured, the dimension that first reaches the threshold is used.

Minimum: 0

Maximum: 1073741823

Default: 1073741823

backlog_time

No

Integer

Parameter description: Data backlog time. The value is an integer ranging from 0 to 86399, in seconds. The default value is 86399 (one day). If the value of backlog_time is 0, messages are not stacked. If both backlog_size and backlog_time are configured, the dimension that first reaches the threshold is used.

Minimum: 0

Maximum: 86399

Default: 86399

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

policy_id

String

Parameter description: ID of the data stacking policy. The value of this parameter is unique and is allocated by the platform during data stacking policy creation.

policy_name

String

Parameter description: Name of a data transfer stacking 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 stacking policy. Value: The value can contain a maximum of 256 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed.

Minimum: 1

Maximum: 256

backlog_size

Integer

Parameter description: Size of stacked data. The value is an integer ranging from 0 to 1073741823, in bytes. The default value is 1073741823 (1 GB). If the value of backlog_size is 0, logs are not stacked. If both backlog_size and backlog_time are configured, the dimension that first reaches the threshold is used.

Minimum: 0

Maximum: 1073741823

Default: 1073741823

backlog_time

Integer

Parameter description: Data backlog time. The value is an integer ranging from 0 to 86399, in seconds. The default value is 86399 (one day). If the value of backlog_time is 0, messages are not stacked. If both backlog_size and backlog_time are configured, the dimension that first reaches the threshold is used.

Minimum: 0

Maximum: 86399

Default: 86399

Example Requests

Update a stack policy.

PUT https://{endpoint}/v5/iot/{project_id}/routing-rule/backlog-policy/{policy_id}

{
  "backlog_size" : 100,
  "backlog_time" : 100
}

Example Responses

Status code: 200

Ok

{
  "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34",
  "policy_name" : "policyName",
  "description" : "description",
  "backlog_size" : 1073741823,
  "backlog_time" : 86399
}

Status Codes

Status Code

Description

200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.