All Products
Search
Document Center

Data Management:GetApprovalDetail

Last Updated:Aug 27, 2026

Queries approval details for a 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:GetApprovalDetail

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Tid

integer

No

Tenant ID. Call GetUserActiveTenant to query this ID.

3***

WorkflowInstanceId

integer

Yes

Approval process ID. Call GetOrderBaseInfo to query this ID.

184****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

66DE630B-ECA1-52A3-9198-602066F9****

ErrorCode

string

Error code returned on failure.

MissingWorkflowInstanceId

ErrorMessage

string

Error message returned on failure.

WorkflowInstanceId is mandatory for this action.

ApprovalDetail

object

Approval details of the ticket.

WorkflowNodes

object

WorkflowNode

array<object>

Approval node details.

array<object>

OperateTime

string

Time when the ticket was submitted.

2019-10-15 13:47:54

OperatorId

integer

ID of the user who submitted the ticket.

1****

NodeName

string

Approval node name.

DBA

AuditUserIdList

object

AuditUserIds

array

Approver IDs.

string

Approver ID.

10****

OperateComment

string

Approval remarks.

理由:同意

WorkflowInsCode

string

Approval status of the ticket. Valid values:

  • START: The ticket was submitted.

  • ERROR: An error occurred.

  • AUDITING: The ticket is being reviewed.

  • REJECT: The ticket was rejected.

  • CANCEL: The ticket was revoked.

  • APPROVED: The ticket was approved.

APPROVED

Description

string

Approval process description.

【实例权限】申请
权限类型:「登录」
申请期限:30.0 days
背景描述:【实例权限】test登录

【申请列表】
product rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306 - PRODUCT






CreateTime

string

Time when the approval process was created.

2021-10-29 14:17:25

CurrentHandlers

object

CurrentHandler

array<object>

Approver details.

object

NickName

string

User nickname.

nickName

Id

integer

User ID.

1

OrderType

string

Ticket type. Valid values:

  • NDDL: a schema design ticket

  • DATA_TRACK: a data tracking ticket

  • TABLE_SYNC: a table synchronization ticket

  • PERM_APPLY: a permission application ticket

  • DATA_EXPORT: a data export ticket

  • DATA_CORRECT: a data change ticket

  • OWNER_APPLY: an owner role application ticket

  • SENSITIVITY: a column sensitivity level change ticket

PERM_APPLY

Title

string

Approval process title.

权限申请工单-384****

AuditId

integer

Approval process ID.

184****

OrderId

integer

Ticket ID.

384****

WorkflowInsCode

string

Approval status of the ticket. Valid values:

  • AUDITING: The ticket is being reviewed.

  • REJECT: The ticket was rejected.

  • CANCEL: The ticket was revoked.

  • APPROVED: The ticket was approved.

Note

Returned for each approval node in the process.

APPROVED

ReasonList

object

Reasons

array

Approval reasons.

string

Approval reason.

根据安全规则,权限申请需要审批

TemplateId

integer

Workflow template ID.

1234

ThirdpartyWorkflowUrl

string

URL of the third-party approval workflow.

https://xxx

ThirdpartyWorkflowComment

string

Remarks from the third-party approval workflow.

test

Success

boolean

Whether the request succeeded. Valid values:

  • true: The request succeeded.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "RequestId": "66DE630B-ECA1-52A3-9198-602066F9****",
  "ErrorCode": "MissingWorkflowInstanceId",
  "ErrorMessage": "WorkflowInstanceId is mandatory for this action.",
  "ApprovalDetail": {
    "WorkflowNodes": {
      "WorkflowNode": [
        {
          "OperateTime": "2019-10-15 13:47:54",
          "OperatorId": 0,
          "NodeName": "DBA",
          "AuditUserIdList": {
            "AuditUserIds": [
              "10****"
            ]
          },
          "OperateComment": "理由:同意",
          "WorkflowInsCode": "APPROVED"
        }
      ]
    },
    "Description": "【实例权限】申请权限类型:「登录」申请期限:30.0 days背景描述:【实例权限】test登录【申请列表】product rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306 - PRODUCT",
    "CreateTime": "2021-10-29 14:17:25",
    "CurrentHandlers": {
      "CurrentHandler": [
        {
          "NickName": "nickName",
          "Id": 1
        }
      ]
    },
    "OrderType": "PERM_APPLY",
    "Title": "权限申请工单-384****",
    "AuditId": 0,
    "OrderId": 0,
    "WorkflowInsCode": "APPROVED",
    "ReasonList": {
      "Reasons": [
        "根据安全规则,权限申请需要审批"
      ]
    },
    "TemplateId": 1234,
    "ThirdpartyWorkflowUrl": "https://xxx",
    "ThirdpartyWorkflowComment": "test"
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.