GetApprovalDetail - Data Management - Alibaba Cloud Documentation Center

Queries the approval details of 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:
- The required resource types are displayed in bold characters.
- 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:GetApprovalDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.	3***
WorkflowInstanceId	long	Yes	The ID of the approval process. You can call the GetOrderBaseInfo operation to obtain the ID of the approval process.	184****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	66DE630B-ECA1-52A3-9198-602066F9****
ErrorCode	string	The error code returned if the request failed.	MissingWorkflowInstanceId
ErrorMessage	string	The error message returned if the request failed.	WorkflowInstanceId is mandatory for this action.
ApprovalDetail	object	The approval details of the ticket.
WorkflowNodes	array<object>	The details of approval nodes.
WorkflowNode	object
OperateTime	string	The time when the ticket was submitted.	2019-10-15 13:47:54
OperatorId	long	The ID of the user who submitted the ticket.	1****
NodeName	string	The name of the approval node.	DBA
AuditUserIdList	array	The IDs of the approvers.
AuditUserIds	string	The ID of the approver.	10****
OperateComment	string	The remarks of the approval.	Reason: Approved
WorkflowInsCode	string	The 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	The description of the approval process.	\[Instance permissions] Application\<br/>Permission type: ⌈Logon⌋\<br/>Application period: 30.0 days\<br/>Background description: \[Instance permissions] logon test\<br/>\<br/>\[Application list]\<br/>\<span style='color:red'>product\</span> rm-bp144d5ky4l4rli0417\\\\.mysql.rds.aliyuncs.com:3306 - PRODUCT\<br/>
CreateTime	string	The time when the approval process was created.	2021-10-29 14:17:25
CurrentHandlers	array<object>	The information about the approver.
CurrentHandler	object
NickName	string	The nickname of the user.	nickName
Id	long	The ID of the user.	1
OrderType	string	The type of the ticket. 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	The title of the approval process.	Permission application ticket - 384\\\\
AuditId	long	The ID of the approval process.	184****
OrderId	long	The ID of the ticket.	384****
WorkflowInsCode	string	The 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 An approval process contains multiple approval nodes, and this parameter is returned for each approval node.	APPROVED
ReasonList	array	The reasons for the approval.
Reasons	string	The reason for the approval.	According to security rules, permission applications need to be approved.
TemplateId	long	The ID of the workflow template.	1234
ThirdpartyWorkflowUrl	string	The third-party approval flow link.	https://xxx
ThirdpartyWorkflowComment	string	Third-party approval flow remarks.	test
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Sample success responses

JSONformat

{
  "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": "Reason: Approved\n",
          "WorkflowInsCode": "APPROVED"
        }
      ]
    },
    "Description": "\\[Instance permissions] Application\\<br/>Permission type: ⌈Logon⌋\\<br/>Application period: 30.0 days\\<br/>Background description: \\[Instance permissions] logon test\\<br/>\\<br/>\\[Application list]\\<br/>\\<span style='color:red'>product\\</span> rm-bp144d5ky4l4rli0417\\*\\*\\*\\*.mysql.rds.aliyuncs.com:3306 - PRODUCT\\<br/>\n",
    "CreateTime": "2021-10-29 14:17:25",
    "CurrentHandlers": {
      "CurrentHandler": [
        {
          "NickName": "nickName",
          "Id": 1
        }
      ]
    },
    "OrderType": "PERM_APPLY",
    "Title": "Permission application ticket - 384\\*\\*\\*\\*\n",
    "AuditId": 0,
    "OrderId": 0,
    "WorkflowInsCode": "APPROVED",
    "ReasonList": {
      "Reasons": [
        "According to security rules, permission applications need to be approved.\n"
      ]
    },
    "TemplateId": 1234,
    "ThirdpartyWorkflowUrl": "https://xxx",
    "ThirdpartyWorkflowComment": "test"
  },
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history