调用 GetUserUploadFileJob获取上传附件的任务信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
JobKey String 65254a49100e

上传附件任务JobKey。

Tid Long -1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见 查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

UploadFileJobDetail object

上传附件任务详情。

JobKey String 65254a4c1614235217749100e

上传附件任务JobKey。

FileName String test.sql

文件名。

FileSize Long 2968269

文件大小,单位为字节。

FileSource String datacorrect

文件上传的使用目的,取值与说明如下:

  • datacorrect:数据变更工单
  • order_info_attachment:工单附件
  • big-file:批量数据导入
  • sqlreview:SQL审核
UploadType String URL

上传附件任务类型,取值:

  • URL
  • OSS
UploadURL String http://xxxx/test.sql

上传附件URL链接。

说明UploadType参数为 URL时显示。
UploadOSSParam object

上传附件OSS信息。

说明UploadType参数为 OSS时显示。
Endpoint String http://oss-cn-hangzhou.aliyuncs.com

OSS的连接地址。

BucketName String test_bucket

OSS Bucket唯一标识。

ObjectName String test.sql

OSS对象名称。

UploadedSize Long 2968269

已上传的大小,单位为字节。

JobStatus String SUCCESS

上传附件任务状态,取值和说明如下:

  • INIT:初始化状态
  • PENDING:等待任务抓取
  • BE_SCHEDULED:待调度
  • FAIL:执行失败
  • SUCCESS:执行成功
  • RUNNING:正在执行
JobStatusDesc String success

任务状态描述。

AttachmentKey String upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql

上传附件成功后返回的附件Key,可在创建工单时使用。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?JobKey=65254a4c1614235217749100e
&Tid=-1
&公共请求参数

正常返回示例

XML格式

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

<GetUserUploadFileJobResponse>
    <RequestId>22FFF57C-6E85-4C3D-90AF-C1BFE79E1FAF</RequestId>
    <UploadFileJobDetail>
        <JobStatus>INIT</JobStatus>
        <JobKey>7000005000007000009000000</JobKey>
        <UploadURL>https://dbxxx.oss-cn-hangzhou.aliyuncs.com/dm/1.txt</UploadURL>
        <UploadedSize>0</UploadedSize>
        <JobStatusDesc/>
        <FileSource>datacorrect</FileSource>
        <FileName>1.txt</FileName>
        <UploadType>URL</UploadType>
        <FileSize>-1</FileSize>
    </UploadFileJobDetail>
    <Success>true</Success>
</GetUserUploadFileJobResponse>

JSON格式

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

{
  "RequestId" : "22FFF57C-6E85-4C3D-90AF-C1BFE79E1FAF",
  "UploadFileJobDetail" : {
    "JobStatus" : "INIT",
    "JobKey" : "7000005000007000009000000",
    "UploadURL" : "https://dbxxx.oss-cn-hangzhou.aliyuncs.com/dm/1.txt",
    "UploadedSize" : 0,
    "JobStatusDesc" : "",
    "FileSource" : "datacorrect",
    "FileName" : "1.txt",
    "UploadType" : "URL",
    "FileSize" : -1
  },
  "Success" : true
}

错误码

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