Query the Data Transfer Stacking Policy

Function

This API is used by an application to query a specified data transfer and stacking policy on the IoT platform.

URI

GET /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
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 3** 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.
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.
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.
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.

Example Requests

Queries a specified stack policy.

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

Example Responses

Status code: 200

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