This topic describes the DescribeProjectStepMetric API provided by OceanBase Migration Service (OMS) Community Edition.
Purpose
You can call this operation to query metrics of steps in a data migration or synchronization project.
Call description
Limitations
This operation is applicable to OMS Community Edition V4.1.1 and later versions.
Request path
POST /api/v2?Action=DescribeProjectStepMetric
Request parameters
| Parameter | Type | Description |
|---|---|---|
| projectId | string | The project ID. |
| stepName | string | The name of the step. Valid values: FULL_TRANSFER, INCR_TRANSFER, FULL_VERIFIER, and REVERSE_INCR_TRANSFER. |
| metricType | string | The metric that you want to query. The metric corresponds to the step of project execution.
|
| aggregator | string | The aggregate operator. Valid values: AVG (line chart of average data) and NONE (line chart of instantaneous data). Default value: NONE. |
| beginTimestamp | integer | The start time. The value is a second-level timestamp. The interval between the start time and the end time must not be shorter than one hour. |
| endTimestamp | integer | The end time. The value is a second-level timestamp. The end time cannot be later than the current time. |
| maxPointNum | integer | The maximum number of query points. |
Return result
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The error description. |
| advice | string | The suggestions about how to resolve the error. |
| requestId | string | The request ID. |
| pageNumber | integer | The number of the page to return. |
| pageSize | integer | The number of entries to return on each page. |
| totalCount | integer | The total number of entries returned. |
| cost | string | The time spent in processing the request, in seconds. |
| data | string | The information about steps in the project. For more information, see the "Parameters in data" section of this topic. |
Parameters in data
Parameter Type Description referenceValue integer The reference value. metrics array The line chart of metric data. ├─ name string The name of the metric. ├─ tags map The tag of the metric. ├─ dataPoints array The list of metric data. aggregator string The aggregate operator. Valid values: AVG(line chart of average data) andNONE(line chart of instantaneous data).
Examples
Sample request
{
"projectId":"np_4w3r****",
"stepName":"FULL_VERIFIER",
"metricType":"FULL_VERIFY_DEST_READ_IOPS",
"aggregator":"NONE",
"beginTimestamp ":"1689244429",
"endTimestamp":"1689248029",
"maxPointNum":"84"
}
Sample response
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":"a7b57****",
"pageNumber":null,
"pageSize":null,
"totalCount":null,
"cost":"27 ms",
"data":{
"referenceValue":null,
"metrics":[
{
"name":null,
"tags":null,
"dataPoints":[
{
"timestamp":1689244596,
"value":0
},
{
"timestamp":1689244646,
"value":0
},
{
"timestamp":1689244696,
"value":0
}
]
}
],
"aggregator":"NONE"
}
}