全部产品
Search
文档中心

数据管理 DMS:GetApprovalDetail - 获取工单审批详情

更新时间:Nov 28, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetApprovalDetailget
*全部资源
*

请求参数

名称类型必填描述示例值
Tidlong

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

3***
WorkflowInstanceIdlong

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

184****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

错误码。

MissingWorkflowInstanceId
ErrorMessagestring

错误信息。

WorkflowInstanceId is mandatory for this action.
ApprovalDetailobject

工单审批详情信息。

WorkflowNodesarray<object>

审批流程节点信息。

WorkflowNodeobject

节点信息。

OperateTimestring

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

2019-10-15 13:47:54
OperatorIdlong

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

1****
NodeNamestring

审批节点名称。

DBA
AuditUserIdListarray

审批工单的用户 ID 列表。

AuditUserIdsstring

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

10****
OperateCommentstring

审批操作备注。

理由:同意
WorkflowInsCodestring

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

  • START:初始状态
  • ERROR:异常状态
  • AUDITING:审批中
  • REJECT:审批拒绝
  • CANCEL:撤销审批
  • APPROVED:已批准
APPROVED
Descriptionstring

审批描述信息。

【实例权限】申请<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/>
CreateTimestring

审批流程创建时间。

2021-10-29 14:17:25
CurrentHandlersarray<object>

当前审批处理人信息。

CurrentHandlerobject

审批人信息。

NickNamestring

用户昵称。

nickName
Idlong

用户 ID。

1
OrderTypestring

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

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

审批标题。

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

审核单 ID。

184****
OrderIdlong

工单 ID。

384****
WorkflowInsCodestring

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

  • AUDITING:审批中
  • REJECT:审批拒绝
  • CANCEL:撤销审批
  • APPROVED:已批准
说明 一个审批流程包含了多层审批,每层都有其审批的状态码。
APPROVED
ReasonListarray

审批原因列表。

Reasonsstring

审批原因。

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

工作流模板 ID。

1234
ThirdpartyWorkflowUrlstring

第三方审批流链接。

https://xxx
ThirdpartyWorkflowCommentstring

第三方审批流备注。

test
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "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": "【实例权限】申请<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": "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
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史