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

Queries the task information about a ticket.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetPagedInstance	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of data archiving ticket.	868*****
Tid	long	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 parameters

Parameter	Type	Description	Example
	object
TraceId	string	The trace ID, which is used to track the request.	0a06e1e316757357507896067d3780
Success	boolean	Indicates whether the request was successful. Valid values: true false: The request failed.	true
ErrorMessage	string	The error message that is returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
PageIndex	long	The page number.	1
RequestId	string	The request ID. You can use the request ID to query logs and troubleshoot issues.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
PageSize	long	The number of entries to return on each page.	10
Total	long	The total number of instances.	2
Data	object	The data returned.
Instance	array<object>	The information about the task.
instance	object	The details of the task.
BusinessTime	string	The data timestamp of the task node.	2023-05-14 16:00:57
CheckStatus	long	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	long	The unique ID of the task flow.	33753
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	long	The ID of the historical task flow.	6851
Id	long	The task flow ID.	24271
LastRunningContext	string	The context of the last execution of the task flow.	{”nodes":[11694,11695]"}
Msg	string	The details of the current task execution.
Status	long	The state of the archiving task. 0: Pending. 1: Running. 2: Paused. 3: Failed. 4: Succeeded.	1
TaskType	long	The task type. Valid values: 1: data archiving 2: archived data restoration 3: archived data verification	1
TenantId	string	The ID of the tenant.	3406
TriggerType	long	The mode in which the task flow is triggered. 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.	1

Examples

Sample success responses

JSONformat

{
  "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": 33753,
        "Delete": false,
        "EndTime": "2023-04-23 10:23:20",
        "GmtCreate": "2023-03-28 10:50:45",
        "GmtModified": "2023-04-18 15:28:16",
        "HistoryDagId": 6851,
        "Id": 24271,
        "LastRunningContext": "{”nodes\":[11694,11695]\"}",
        "Msg": "",
        "Status": 1,
        "TaskType": 1,
        "TenantId": 3406,
        "TriggerType": 1,
        "Version": 1
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.