Call the GetPagedInstance API to query task information of a ticket - Data Management - Alibaba Cloud - Data Management

Queries task information about a specified ticket.

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

dms:GetPagedInstance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the data archiving ticket.	868*****
Tid	integer	No	The ID of the tenant. Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***

Response elements

Element	Type	Description	Example
	object
TraceId	string	The trace ID of the request, used for tracking.	0a06e1e316757357507896067d3780
Success	boolean	Indicates whether the request was successful. Valid values: true false: The request failed.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
PageIndex	integer	The page number.	1
RequestId	string	The request ID, which can be used to query logs and troubleshoot issues.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
PageSize	integer	The number of entries returned per page.	10
Total	integer	The total number of instances.	2
Data	object	The data returned.
Instance	array<object>	The task information.
	object	The task details.
BusinessTime	string	The data timestamp of the task node.	2023-05-14 16:00:57
CheckStatus	integer	The state of archived data verification. Valid values: 0: The verification was successful. 1: Inconsistent data was detected. 2: The verification was not performed. 3: The verification is in progress. 4: The verification was interrupted.	3
DagId	integer	The unique ID of the task flow.	33***
Delete	string	Indicates whether the source data is deleted. Valid values: true: deletes the jobs in the application group. false	false
EndTime	string	The time when the task ended.	2023-04-23 10:23:20
GmtCreate	string	The time when the task flow was created.	2023-03-28 10:50:45
GmtModified	string	The time when the task flow was last modified.	2023-04-18 15:28:16
HistoryDagId	integer	The ID of the historical task flow.	68***
Id	integer	The task flow ID.	24****
LastRunningContext	string	The context of the last task flow execution.	{”nodes":[11*,11*]"}
Msg	string	The details of the current task execution.	”Archiving task log: xxxx”
Status	integer	The state of the archiving task. 0: Pending. 1: Running. 2: Paused. 3: Failed. 4: Succeeded.	1
TaskType	integer	The task type. Valid values: 1: data archiving 2: archived data restoration 3: archived data verification	1
TenantId	string	The ID of the tenant.	34***
TriggerType	integer	The trigger mode of the task flow. Valid values: 0: The task flow was triggered based on a schedule. 1: The task flow was manually triggered.	1
Version	string	The version number.	13***

Examples

Success response

JSON format

{
  "TraceId": "0a06e1e316757357507896067d3780",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PageIndex": 1,
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "PageSize": 10,
  "Total": 2,
  "Data": {
    "Instance": [
      {
        "BusinessTime": "2023-05-14 16:00:57",
        "CheckStatus": 3,
        "DagId": 0,
        "Delete": "false",
        "EndTime": "2023-04-23 10:23:20",
        "GmtCreate": "2023-03-28 10:50:45",
        "GmtModified": "2023-04-18 15:28:16",
        "HistoryDagId": 0,
        "Id": 0,
        "LastRunningContext": "{”nodes\":[11***,11***]\"}",
        “Msg”: “”Archiving task log: xxxx””,
        "Status": 1,
        "TaskType": 1,
        "TenantId": "34***",
        "TriggerType": 1,
        "Version": "13***"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.