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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetApprovalDetail

The operation that you want to perform. Set the value to GetApprovalDetail.

Tid Long Yes 3***

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

WorkflowInstanceId Long Yes 184****

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

RegionId String No cn-hangzhou

The ID of the region where Data Management (DMS) is activated. Set this parameter to the ID of the region that is close to your services. For more information about the valid values of the parameter, see RegionID parameter.

Response parameters

Parameter Type Example Description
RequestId String 66DE630B-ECA1-52A3-9198-602066F9****

The ID of the request.

ErrorCode String MissingWorkflowInstanceId

The error code returned.

ErrorMessage String WorkflowInstanceId is mandatory for this action.

The error message returned.

ApprovalDetail Object

The approval details of the ticket.

WorkflowNodes Array of WorkflowNode

The details of approval nodes.

WorkflowNode
OperateTime String 2019-10-15 13:47:54

The time when the ticket was submitted.

OperatorId Long 1****

The ID of the user who submitted the ticket.

NodeName String DBA

The name of the approval node.

AuditUserIdList Array of String 10****

The IDs of the approvers.

OperateComment String Reason: approved

The remarks of the approval.

WorkflowInsCode String APPROVED

The approval status of the ticket. Valid values:

  • AUDITING: The ticket is being approved.
  • REJECT: The ticket was rejected.
  • CANCEL: The ticket was revoked.
  • APPROVED: The ticket was approved.
Description String [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/>

The description of the approval process.

CreateTime String 2021-10-29 14:17:25

The time when the approval process was created.

CurrentHandlers Array of CurrentHandler

The information about the approver.

CurrentHandler
NickName String nickName

The nickname of the approver.

Id Long 1

The ID of the approver.

OrderType String PERM_APPLY

The type of the ticket. Valid values:

  • NDDL: a schema design ticket.
  • DATA_TRACK: a data tracking ticket.
  • TABLE_SYNC: a database and 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 application ticket.
  • SENSITIVITY: a column sensitivity level change ticket.
Title String Permission Application Ticket - 384****

The title of the approval process.

AuditId Long 184****

The ID of the approval process.

OrderId Long 384****

The ID of the ticket.

WorkflowInsCode String APPROVED

The approval status of the ticket. Valid values:

  • AUDITING: The ticket is being approved.
  • REJECT: The ticket was rejected.
  • CANCEL: The ticket was revoked.
  • APPROVED: The ticket was approved.
Note If an approval process contains multiple approval nodes, this parameter is returned for each approval node.
ReasonList Array of String According to security rules, permission applications need to be approved.

The reason for the approval.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=GetApprovalDetail
&Tid=3***
&WorkflowInstanceId=184****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetApprovalDetailResponse>
    <RequestId>66DE630B-ECA1-52A3-9198-602066F9****</RequestId>
    <ApprovalDetail>
        <CurrentHandlers>
        </CurrentHandlers>
        <ReasonList>
            <Reasons>According to security rules, permission applications need to be approved.</Reasons>
        </ReasonList>
        <Description>[Instance permissions] Application&lt;br/&gt;Permission type: ⌈Logon⌋&lt;br/&gt;Application period: 30.0 days&lt;br/&gt;Background description: [Instance permissions] logon test&lt;br/&gt;&lt;br/&gt;[Application list]&lt;br/&gt;&lt;span style='color:red'&gt;product&lt;/span&gt; rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306 - PRODUCT&lt;br/&gt;</Description>
        <OrderType>PERM_APPLY</OrderType>
        <WorkflowInsCode>APPROVED</WorkflowInsCode>
        <CreateTime>2021-10-29 14:17:25</CreateTime>
        <AuditId>184****</AuditId>
        <Title>Permission Application Ticket - 384****</Title>
        <OrderId>384****</OrderId>
        <WorkflowNodes>
            <WorkflowNode>
                <OperateTime>2021-10-29 14:20:44</OperateTime>
                <WorkflowInsCode>APPROVED</WorkflowInsCode>
                <NodeName>DBA</NodeName>
                <OperateComment>Reason: approved</OperateComment>
                <OperatorId>10****</OperatorId>
                <AuditUserIdList>
                    <AuditUserIds>10****</AuditUserIds>
                </AuditUserIdList>
            </WorkflowNode>
        </WorkflowNodes>
    </ApprovalDetail>
    <Success>true</Success>
</GetApprovalDetailResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "66DE630B-ECA1-52A3-9198-602066F9****",
  "ApprovalDetail" : {
    "CurrentHandlers" : {
      "CurrentHandler" : [ ]
    },
    "ReasonList" : {
      "Reasons" : [ "According to security rules, permission applications need to be 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/>",
    "OrderType" : "PERM_APPLY",
    "WorkflowInsCode" : "APPROVED",
    "CreateTime" : "2021-10-29 14:17:25",
    "AuditId" : "184****",
    "Title" : "Permission Application Ticket - 384****",
    "OrderId" : "384****",
    "WorkflowNodes" : {
      "WorkflowNode" : [ {
        "OperateTime" : "2021-10-29 14:20:44",
        "WorkflowInsCode" : "APPROVED",
        "NodeName" : "DBA",
        "OperateComment" : "Reason: approved",
        "OperatorId" : "10****",
        "AuditUserIdList" : {
          "AuditUserIds" : [ "10****" ]
        }
      } ]
    }
  },
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.