tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRealTimeTaskMetricOverview

Last updated: 2024-06-21 15:11:00

1. API Description

Domain name for API request: wedata.tencentcloudapi.com.

Real-time Task Running Metrics Overview

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeRealTimeTaskMetricOverview.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TaskId Yes String Task ID of the real-time task to be viewed, which can be obtained from the task list page
ProjectId Yes String Project ID to be viewed
StartTime No Integer Start Time
EndTime No Integer End time

3. Output Parameters

Parameter Name Type Description
TotalRecordNumOfRead Integer Total Read Records
TotalRecordByteNumOfRead Integer Total Read Bytes
TotalRecordNumOfWrite Integer Total Write Records
TotalRecordByteNumOfWrite Integer Total Write Bytes Unit: bytes
TotalDirtyRecordNum Integer Total Dirty Record Data
TotalDirtyRecordByte Integer Total Dirty Bytes Unit: bytes
TotalDuration Integer Execution Duration Unit: s
BeginRunTime String Start Running Time
EndRunTime String Current Running Time
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Real-time Task Running Metrics Overview

Real-time Task Running Metrics Overview

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealTimeTaskMetricOverview
<Common request parameters>

{
    "ProjectId": "1486446569620893696",
    "TaskId": "j224b9321-3be0-45de-ad6a-8fed924036a4",
    "StartTime": 1669693200000,
    "EndTime": 1669693200000
}

Output Example

{
    "Response": {
        "TotalRecordNumOfRead": 91171,
        "TotalRecordByteNumOfRead": 91171,
        "TotalRecordNumOfWrite": 91171,
        "TotalRecordByteNumOfWrite": 191171,
        "TotalDirtyRecordNum": 91171,
        "TotalDirtyRecordByte": 91171,
        "TotalDuration": 191171,
        "BeginRunTime": "2022-04-10 16:27:09",
        "EndRunTime": "2022-04-11 17:46:40",
        "RequestId": "55c2c097-26da-4302-b0dc-fc22bd33b54d"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation Failure.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy