全部产品
Search

搜索本产品

    数据管理 DMS：GetOrderBaseInfo - 获取工单基本信息

    文档中心

    数据管理 DMS：GetOrderBaseInfo - 获取工单基本信息

    更新时间：Nov 06, 2024

    调用GetOrderBaseInfo获取工单基本信息。

    调试

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

    授权信息

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

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

    请求参数

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

    租户 ID。

    说明 取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。
    		-1
    OrderIdlong是

    工单 ID。

    		12345

    返回参数

    名称类型描述示例值
    object
    OrderBaseInfoobject

    工单基本信息。

    RelatedUserNickListarray

    工单相关人昵称列表。

    UserNicksstring

    工单相关人昵称。

    		nickname
    Commentstring

    备注信息。

    		test
    CreateTimestring

    工单创建时间。

    		2019-10-10 00:00:00
    Committerstring

    提交者。

    		xxx
    WorkflowInstanceIdlong

    审批流 ID。

    		1
    CommitterIdlong

    提交者 ID，注意不是提交者的阿里云 UID。

    		1
    LastModifyTimestring

    工单最后修改时间。

    		2019-10-10 00:00:00
    StatusCodestring

    工单状态码，取值如下：

    • new：新建
    • toaudit：审批中
    • approved：审批通过
    • reject：审批拒绝
    • processing：执行中
    • success：执行成功
    • closed：已关闭
    		success
    RelatedUserListarray

    工单相关人 ID 列表。

    UserIdsstring

    工单相关人 ID。

    		1
    WorkflowStatusDescstring

    审批描述信息。

    		approved
    StatusDescstring

    状态描述信息。

    		success
    PluginTypestring

    工单类型。取值及说明可参考 CreateOrder 接口的相应入参说明。

    		DC_COMMON
    OrderIdlong

    工单号。

    		12345
    AttachmentKeystring

    工单附件 Key。仅当工单创建时上传了附件，才会返回此信息。

    		upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png
    OriginAttachmentNamestring

    工单附件原始文件名。仅当工单创建时上传了附件，才会返回此信息。

    		18072d8a9bce876e3073bc655c2865f.png
    RequestIdstring

    请求 ID。

    		7133DF67-5B25-460F-8285-C4CC93472C2F
    ErrorCodestring

    错误码。

    		UnknownError
    ErrorMessagestring

    错误信息。

    		UnknownError
    Successboolean

    请求是否成功。

    		true

    示例

    正常返回示例

    JSON格式

    {
  "OrderBaseInfo": {
    "RelatedUserNickList": {
      "UserNicks": [
        "nickname"
      ]
    },
    "Comment": "test",
    "CreateTime": "2019-10-10 00:00:00",
    "Committer": "xxx",
    "WorkflowInstanceId": 1,
    "CommitterId": 1,
    "LastModifyTime": "2019-10-10 00:00:00",
    "StatusCode": "success",
    "RelatedUserList": {
      "UserIds": [
        "1"
      ]
    },
    "WorkflowStatusDesc": "approved",
    "StatusDesc": "success",
    "PluginType": "DC_COMMON",
    "OrderId": 12345,
    "AttachmentKey": "upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png",
    "OriginAttachmentName": "18072d8a9bce876e3073bc655c2865f.png"
  },
  "RequestId": "7133DF67-5B25-460F-8285-C4CC93472C2F",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-10-12OpenAPI 返回结构发生变更查看变更详情