调用GetApprovalDetail获取工单审批详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetApprovalDetail

系统规定参数。取值:GetApprovalDetail

Tid Long 3***

租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。

WorkflowInstanceId Long 184****

审批流ID,可通过调用接口GetOrderBaseInfo获取该参数的值。

RegionId String cn-hangzhou

DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
RequestId String 66DE630B-ECA1-52A3-9198-602066F9****

请求ID。

ErrorCode String MissingWorkflowInstanceId

错误码。

ErrorMessage String WorkflowInstanceId is mandatory for this action.

错误信息。

ApprovalDetail Object

工单审批详情信息。

WorkflowNodes Array of WorkflowNode

审批流程节点信息。

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

提交工单审批流程的时间。

OperatorId Long 1****

提交工单审批流程的用户ID。

NodeName String DBA

审批节点名称。

AuditUserIdList Array of String 10****

审批工单的用户ID列表,此处具体返回审批工单的用户ID。

OperateComment String 理由:同意

审批操作备注。

WorkflowInsCode String APPROVED

工单审批状态,返回值说明如下:

  • AUDITING:审批中
  • REJECT:审批拒绝
  • CANCEL:撤销审批
  • APPROVED:已批准
Description String 【实例权限】申请<br/>权限类型:「登录」<br/>申请期限:30.0 days<br/>背景描述:【实例权限】test登录<br/><br/>【申请列表】<br/><span style='color:red'>product</span> rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306 - PRODUCT<br/>

审批描述信息。

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

审批流程创建时间。

CurrentHandlers Array of CurrentHandler

当前审批处理人信息。

CurrentHandler
NickName String nickName

用户昵称。

Id Long 1

用户ID。

OrderType String PERM_APPLY

工单类型,返回值说明如下:

  • NDDL:结构设计
  • DATA_TRACK:数据追踪
  • TABLE_SYNC:库表同步
  • PERM_APPLY:权限申请
  • DATA_EXPORT:数据导出
  • DATA_CORRECT:数据变更
  • OWNER_APPLY:Owner申请
  • SENSITIVITY:敏感列等级调整
Title String 权限申请工单-384****

审批标题。

AuditId Long 184****

审核单ID。

OrderId Long 384****

工单ID。

WorkflowInsCode String APPROVED

工单审批状态,返回值说明如下:

  • AUDITING:审批中
  • REJECT:审批拒绝
  • CANCEL:撤销审批
  • APPROVED:已批准
说明 一个审批流程包含了多层审批,每层都有其审批的状态码。
ReasonList Array of String 根据安全规则,权限申请需要审批

审批原因。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetApprovalDetail
&Tid=3***
&WorkflowInstanceId=184****
&<公共请求参数>

正常返回示例

XML格式

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

<GetApprovalDetailResponse>
    <RequestId>66DE630B-ECA1-52A3-9198-602066F9****</RequestId>
    <ApprovalDetail>
        <CurrentHandlers>
        </CurrentHandlers>
        <ReasonList>
            <Reasons>根据安全规则,权限申请需要审批</Reasons>
        </ReasonList>
        <Description>【实例权限】申请&lt;br/&gt;权限类型:「登录」&lt;br/&gt;申请期限:30.0 days&lt;br/&gt;背景描述:【实例权限】test登录&lt;br/&gt;&lt;br/&gt;【申请列表】&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>权限申请工单-384****</Title>
        <OrderId>384****</OrderId>
        <WorkflowNodes>
            <WorkflowNode>
                <OperateTime>2021-10-29 14:20:44</OperateTime>
                <WorkflowInsCode>APPROVED</WorkflowInsCode>
                <NodeName>DBA</NodeName>
                <OperateComment>原因:同意</OperateComment>
                <OperatorId>10****</OperatorId>
                <AuditUserIdList>
                    <AuditUserIds>10****</AuditUserIds>
                </AuditUserIdList>
            </WorkflowNode>
        </WorkflowNodes>
    </ApprovalDetail>
    <Success>true</Success>
</GetApprovalDetailResponse>

JSON格式

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

{
  "RequestId" : "66DE630B-ECA1-52A3-9198-602066F9****",
  "ApprovalDetail" : {
    "CurrentHandlers" : {
      "CurrentHandler" : [ ]
    },
    "ReasonList" : {
      "Reasons" : [ "根据安全规则,权限申请需要审批" ]
    },
    "Description" : "【实例权限】申请<br/>权限类型:「登录」<br/>申请期限:30.0 days<br/>背景描述:【实例权限】test登录<br/><br/>【申请列表】<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" : "权限申请工单-384****",
    "OrderId" : "384****",
    "WorkflowNodes" : {
      "WorkflowNode" : [ {
        "OperateTime" : "2021-10-29 14:20:44",
        "WorkflowInsCode" : "APPROVED",
        "NodeName" : "DBA",
        "OperateComment" : "原因:同意",
        "OperatorId" : "10****",
        "AuditUserIdList" : {
          "AuditUserIds" : [ "10****" ]
        }
      } ]
    }
  },
  "Success" : true
}

错误码

访问错误中心查看更多错误码。