All Products
Search
Document Center

Data Management:GetApprovalDetail

Last Updated:Mar 14, 2024

Queries the approval details of a ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetApprovalDetailRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.

3***
WorkflowInstanceIdlongYes

The ID of the approval process. You can call the GetOrderBaseInfo operation to obtain the ID of the approval process.

184****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The error code returned if the request failed.

MissingWorkflowInstanceId
ErrorMessagestring

The error message returned if the request failed.

WorkflowInstanceId is mandatory for this action.
ApprovalDetailobject

The approval details of the ticket.

WorkflowNodesobject []

The details of approval nodes.

OperateTimestring

The time when the ticket was submitted.

2019-10-15 13:47:54
OperatorIdlong

The ID of the user who submitted the ticket.

1****
NodeNamestring

The name of the approval node.

DBA
AuditUserIdListarray

The IDs of the approvers.

string

The ID of the approver.

10****
OperateCommentstring

The remarks of the approval.

Reason: Approved
WorkflowInsCodestring

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
Descriptionstring

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/>
CreateTimestring

The time when the approval process was created.

2021-10-29 14:17:25
CurrentHandlersobject []

The information about the approver.

NickNamestring

The nickname of the user.

nickName
Idlong

The ID of the user.

1
OrderTypestring

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
Titlestring

The title of the approval process.

Permission application ticket - 384\*\*\*\*
AuditIdlong

The ID of the approval process.

184****
OrderIdlong

The ID of the ticket.

384****
WorkflowInsCodestring

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
ReasonListarray

The reasons for the approval.

string

The reason for the approval.

According to security rules, permission applications need to be approved.
TemplateIdlong

The ID of the workflow template.

1234
Successboolean

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
  },
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history