All Products
Document Center


Last Updated:Mar 28, 2024

Queries one or more tracking tasks of operations reports.

Operation description

Note You can call this operation up to 3 times per second per account.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • All Resources

Request parameters


The ID of the tracking task that you want to query. If you do not specify an ID, all tracking tasks are queried.


Response parameters


The information about the tracking task.

"data": \[{"deliverId": 1,"status": "enable","createTime": "2020-10-14T11:19:26Z","crontab": "0 0 0 \* \* ?","frequency": "d","name": "The name of the tracking task","dmList": \[""],"reports": \[{"reportId": 1,"conditions": \[{"op": "in","field": "prov","value": \["Heilongjiang","Beijing"]}} },{"reportId": 2}],"deliver": {"email": {"subject": "subject","to": \["",""]}}}]}

The ID of the request.


Fields in the data parameter

deliverIdLongThe ID of the tracking task.
statusStringThe status of the tracking task. Valid values: enable, disable
createTimeStringThe time when the tracking task was created.
crontabStringThe period during which the tracking task runs.
frequencyStringThe interval at which the reports are sent. Valid values: h: hour, d: day, M: month
nameStringThe name of the tracking task.
dmListString[]The domain names from which the tracking task collects data.
reportsString[]The information about the reports released by the tracking task, including:reportId: the ID of the report.conditions: the filter conditions, including the filter action, fields, and values. If no filter conditions are specified, this parameter does not carry a value. op: the filter action. Only in is supported. field: the filter fields. value: the filter values.
deliverStringThe delivery module, including the subject and recipient of the indicates that reports are sent to specified email addresses.subject: the subject of the the recipient of the email.copy: the contacts to whom the email is copied.

Fields in the reports parameter

deliverIdLongThe ID of the tracking task.
statusStringThe status of the tracking task. Valid values: enable, disable


Sample success responses


  "Content": "\"data\": \\[{\"deliverId\": 1,\"status\": \"enable\",\"createTime\": \"2020-10-14T11:19:26Z\",\"crontab\": \"0 0 0 \\* \\* ?\",\"frequency\": \"d\",\"name\": \"The name of the tracking task\",\"dmList\": \\[\"\"],\"reports\": \\[{\"reportId\": 1,\"conditions\": \\[{\"op\": \"in\",\"field\": \"prov\",\"value\": \\[\"Heilongjiang\",\"Beijing\"]}} },{\"reportId\": 2}],\"deliver\": {\"email\": {\"subject\": \"subject\",\"to\": \\[\"\",\"\"]}}}]}\n",
  "RequestId": "12345"

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.-
400TimeParseFailedFailed to parse the time parameter.Failed to parse the time parameter.
400SubscriptionAlreadyExistsThe subscription already exists.The subscription already exists.
400SubscriptionNotFoundThe subscription is not found.The subscription is not found.
400NameAlreadyExistsThe name already exists.The specified name already exists.
400DeliverExceedLimitThe maximum number of subscribed tasks is exceeded.The number of tracking tasks has reached the upper limit.

For a list of error codes, visit the Service error codes.