DescribeProjectSteps-阿里云帮助中心

This operation returns details about the runtime steps 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:DescribeProjectSteps

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The data migration or data synchronization task ID.	np_4w3a****

Response elements

Element	Type	Description	Example
	object	The response data.
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: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	Key-value pairs used to populate placeholders in `Message`.
	any	The value for a placeholder.	null
MessageMcmsKey	string	The key for the error message template.	null
MessageMcmsContext	object	Key-value pairs used to populate placeholders in the template identified by `MessageMcmsKey`.
	string	The value for a placeholder in the template.	null
Reason	string	The error reason.	null
ReasonMcmsKey	string	The key for the error reason template.	null
ReasonMcmsContext	object	Key-value pairs used to populate placeholders in the template identified by `ReasonMcmsKey`.
	string	The value for a placeholder in the template.	null
Proposal	string	The suggestion.	Contact the administrator.
ProposalMcmsKey	string	The key for the suggestion template.	null
ProposalMcmsContext	object	Key-value pairs used to populate placeholders in the template identified by `ProposalMcmsKey`.
	string	The value for a placeholder in the template.	null
UpstreamErrorDetail	any	The error details from an upstream service involved in the HTTP request.	null
Code	string	The error code. This parameter is deprecated. We recommend that you use the `Code` parameter in `ErrorDetail` instead.	INNER_ERROR
Message	string	The error message. This parameter is deprecated. We recommend that you use the `Message` parameter in `ErrorDetail` instead.	A system error occurred.
Advice	string	The suggestion. This parameter is deprecated. We recommend that you use the `Proposal` parameter in `ErrorDetail` instead.	Contact the administrator.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	The page number. This parameter is returned only for paginated responses.	1
PageSize	integer	The page size. This parameter is returned only for paginated responses.	10
TotalCount	integer	The total count. This parameter is returned only for paginated responses.	4
Cost	string	The request duration, in seconds.	1
Data	array<object>	A list of task steps.
	array<object>	The details of a task step.
Order	integer	The execution order of the step.	1
Name	string	The name of the step.	PRE_CHECK
Description	string	The description of the step. Possible values include: pre-check, schema migration, schema synchronization, full migration, full synchronization, full verification, index migration, incremental log fetching, incremental synchronization, incremental verification, and forward switchover.	预检查
Status	string	The step status. Valid values: `INIT` (initializing), `RUNNING` (running), `FAILED` (failed), `FINISHED` (finished), `SUSPEND` (suspended), and `MONITORING`. The `MONITORING` status indicates a continuous monitoring state for incremental synchronization and incremental verification.	RUNNING
ExtraInfo	object	Additional information.
ErrorDetails	array<object>	The error details.
	array<object>
Code	string	The error code.	CM-RESOAT1111
Level	string	The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	Key-value pairs used to populate placeholders in `Message`.
	any	The value for a placeholder.	null
MessageMcmsKey	string	The key for the error message template.	null
MessageMcmsContext	object	Key-value pairs used to populate placeholders in the template identified by `MessageMcmsKey`.
	string	The value for a placeholder in the template.	null
Reason	string	The error reason.	null
ReasonMcmsKey	string	The key for the error reason template.	null
ReasonMcmsContext	object	Key-value pairs used to populate placeholders in the template identified by `ReasonMcmsKey`.
	string	The value for a placeholder in the template.	null
Proposal	string	The suggestion.	null
ProposalMcmsKey	string	The key for the suggestion template.	null
ProposalMcmsContext	object	Key-value pairs used to populate placeholders in the template identified by `ProposalMcmsKey`.
	string	The value for a placeholder in the template.	null
UpstreamErrorDetail	any	The error details from an upstream service involved in the HTTP request.	null
ErrorCode	string	The error code.	INNER_ERROR
ErrorMsg	string	The error message.	The ResourceDirectoryId is invalid.
ErrorParam	object	The parameters related to the error.
	string	The value of an error-related parameter.	null
FailedTime	string	The time when the error occurred.	null
StartTime	string	The start time, in UTC.	2020-05-22T17:04:18
FinishTime	string	The end time, in UTC.	2020-05-22T17:04:18
Progress	integer	The progress of the step, from 0 to 100.	100
StepInfo	object	The execution details of the step. For more information, see the StepInfo data structure.	null

StepInfo data structure

The fields in the stepInfo parameter vary depending on the step.

Cutover (TRANSFER_APP_SWITCH)

Parameter Type Description
checkpointSampleTimestamp long The time the checkpoint was collected, provided as a Unix timestamp in seconds.

Incremental synchronization (INCR_TRANSFER)

Parameter	Type	Description
incrTimestampCheckpoint	long	The checkpoint time, provided as a Unix timestamp in seconds.
checkpointSampleTimestamp	long	The time the checkpoint was collected, provided as a Unix timestamp in seconds.
enableIncrStatistics	boolean	Indicates whether DML/DDL statistics are enabled.

Full verification (FULL_VERIFIER) and full transfer (FULL_TRANSFER)

Parameter	Type	Description
processedRecords	long	The number of rows transferred or verified.
capacity	long	The estimated total number of rows.
srcRps	long	Source read RPS (records per second).
srcRt	long	Source read RT (response time), in milliseconds per record.
srcIops	long	Source read throughput, in bytes per second.
dstRps	long	Target read/write RPS (records per second).
dstRt	long	Target read/write RT (response time), in milliseconds per record.
dstIops	long	Target read/write throughput, in bytes per second.
srcRpsRef	long	The baseline for source read RPS.
dstRpsRef	long	The baseline for target read/write RPS.
dstRtRef	long	The baseline for target read/write RT.

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "Contact the administrator. ",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator. ",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 4,
  "Cost": "1",
  "Data": [
    {
      "Order": 1,
      "Name": "PRE_CHECK",
      "Description": "预检查",
      "Status": "RUNNING",
      "ExtraInfo": {
        "ErrorDetails": [
          {
            "Code": "CM-RESOAT1111",
            "Level": "ERROR",
            "Message": "A system error occurred.",
            "ExtraContext": {
              "key": "null"
            },
            "MessageMcmsKey": "null",
            "MessageMcmsContext": {
              "key": "null"
            },
            "Reason": "null",
            "ReasonMcmsKey": "null",
            "ReasonMcmsContext": {
              "key": "null"
            },
            "Proposal": "null",
            "ProposalMcmsKey": "null",
            "ProposalMcmsContext": {
              "key": "null"
            },
            "UpstreamErrorDetail": "null"
          }
        ],
        "ErrorCode": "INNER_ERROR",
        "ErrorMsg": "The ResourceDirectoryId is invalid.",
        "ErrorParam": {
          "key": "null"
        },
        "FailedTime": "null"
      },
      "StartTime": "2020-05-22T17:04:18",
      "FinishTime": "2020-05-22T17:04:18",
      "Progress": 100,
      "StepInfo": null
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.