DescribeProjectStepMetric-阿里云帮助中心

This API retrieves step-level metrics for a data migration or data synchronization task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeProjectStepMetric

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The ID of the data migration or data synchronization project.	np_dr****
StepName	string	Yes	The name of the task step. You can specify one of the following values: `FULL_TRANSFER` for full transfer, `INCR_TRANSFER` for incremental transfer, `FULL_VERIFIER` for full verification, and `REVERSE_INCR_TRANSFER` for reverse incremental transfer.	FULL_TRANSFER
MetricType	string	Yes	Specifies the metric to query for the task step. The available options depend on the value of `StepName`. For the `FULL_TRANSFER` step, valid metrics are RPS, IOPS, SOURCE_READ_TIME, SOURCE_SLICE_TIME, and SINK_EXECUTE_TIME. For the `INCR_TRANSFER` step, valid metrics are DELAY, IOPS, RPS, SINK_COMMIT_TIME, and SINK_EXECUTE_TIME. For the `FULL_VERIFIER` step, valid metrics are FULL_VERIFY_SOURCE_RPS, FULL_VERIFY_SOURCE_READ_IOPS, FULL_VERIFY_DEST_RPS, and FULL_VERIFY_DEST_READ_IOPS. For the `REVERSE_INCR_TRANSFER` step, valid metrics are RPS, IOPS, DELAY, SINK_EXECUTE_TIME, and SINK_COMMIT_TIME.	RPS
Aggregator	string	Yes	The aggregation method for the metric data. Specify `AVG` to return the average value or `NONE` to return the instantaneous value. The default is `NONE`.	AVG
BeginTimestamp	integer	Yes	The start of the query time range, as a Unix timestamp in seconds. The total time range must be at least one hour.	1689244696
EndTimestamp	integer	Yes	The end of the query time range, as a Unix timestamp in seconds. This value cannot be in the future.	1689254646
MaxPointNum	integer	No	The maximum number of data points to return. The value must be between 5 and 72460. For optimal results, the value should meet the following condition: (time range in minutes) / MaxPointNum > 5.	6

Response elements

Element	Type	Description	Example
	object	The response.
Success	boolean	Indicates whether the call was successful.	true
ErrorDetail	object	The error details.
Code	string	The error code.	CM-RESOAT1111
Level	string	The error level. Valid values include FATAL, ERROR, WARNING, and CRITICAL.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	The key-value pairs used to populate placeholders in the `Message` parameter.
	any	The value for a placeholder in the `Message` parameter.	null
MessageMcmsKey	string	The key used to retrieve a localized error message template.	null
MessageMcmsContext	object	The key-value pairs used to populate placeholders in the template retrieved by `MessageMcmsKey`.
	string	The value for a placeholder in the template retrieved by `MessageMcmsKey`.	null
Reason	string	The reason for the error.	null
ReasonMcmsKey	string	The key used to retrieve a localized template for the error reason.	null
ReasonMcmsContext	object	The key-value pairs used to populate placeholders in the template retrieved by `ReasonMcmsKey`.
	string	The value for a placeholder in the template retrieved by `ReasonMcmsKey`.	null
Proposal	string	The suggestion.	null
ProposalMcmsKey	string	The key used to retrieve a localized template for the suggestion.	null
ProposalMcmsContext	object	The key-value pairs used to populate placeholders in the template retrieved by `ProposalMcmsKey`.
	string	The value for a placeholder in the template retrieved by `ProposalMcmsKey`.	null
UpstreamErrorDetail	any	The details of an error from an upstream service.	null
Code	string	The legacy error code.	INNER_ERROR
Message	string	The legacy error message.	A system error occurred.
Advice	string	The legacy suggestion.	Contact the administrator.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	The page number for paginated queries.	1
PageSize	integer	The number of entries per page, returned for paginated queries.	10
TotalCount	integer	The total number of entries, returned for paginated queries.	1
Cost	string	The request duration, in seconds.	1
Data	object	The metric data for the project step.
ReferenceValue	integer	The reference value.	null
Metrics	array<object>	The time-series data for the metrics.
	array<object>	A metric series.
Name	string	The name of the metric.	metric_name
Tags	object	The set of tags for the metric.
	string	A tag for the metric.	metric_tag
DataPoints	array<object>	A list of data points.
	object	A single data point.
Timestamp	integer	The timestamp of the data point, in milliseconds.	1689244696
Value	number	The value of the metric at the specified timestamp.	0
Aggregator	string	The aggregator. Valid values are `AVG` (for average data) and `NONE` (for instantaneous data).	AVG

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111",
    "Level": "ERROR",
    "Message": "A system error occurred.\n",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.\n",
  "Advice": "Contact the administrator.",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "Cost": "1",
  "Data": {
    "ReferenceValue": 0,
    "Metrics": [
      {
        "Name": "metric_name",
        "Tags": {
          "key": "metric_tag"
        },
        "DataPoints": [
          {
            "Timestamp": 1689244696,
            "Value": 0
          }
        ]
      }
    ],
    "Aggregator": "AVG"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.