Updated on 2024-04-11 GMT+08:00

Query the Data Transfer Stacking Policy List

Function

This API is used by an application to query the list of data transfer and stacking 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/backlog-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

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

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.

Minimum: 1

Maximum: 50

Default: 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.

Default: 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.

Minimum: 0

Maximum: 500

Default: 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

backlog_policies

Array of BacklogPolicyInfo objects

List of data transfer stacking policies.

Array Length: 0 - 50

count

Integer

Total number of records that meet the filter criteria.

Minimum: 0

marker

String

ID of the last record in this query, which can be used in the next query.

Table 5 BacklogPolicyInfo

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

Queries the stack policy list.

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

Example Responses

Status code: 200

Ok

{
  "backlog_policies" : [ {
    "policy_id" : "adadd5cb-6383-4b5b-a65c-f8c92fdf3c34",
    "policy_name" : "policyName",
    "description" : "description",
    "backlog_size" : 1073741823,
    "backlog_time" : 86399
  } ],
  "count" : 10,
  "marker" : "5c90fa7d3c4e4405e8525079"
}

Status Codes

Status Code

Description

200

Ok

400

Bad Request

403

Forbidden

500

Internal Server Error

Error Codes

See Error Codes.