GetUserUploadFileJob - 获取上传附件的任务信息 - 数据管理 DMS

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetUserUploadFileJob

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
JobKey	string	是	上传附件任务 JobKey，您可以通过调用 CreateUploadFileJob 、 CreateUploadOSSFileJob 接口获取该参数。	65254a49100e
Tid	integer	否

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
UploadFileJobDetail	object	上传附件任务详情。
JobKey	string	上传附件任务 JobKey。	65254a4c1614235217749100e
FileName	string	文件名。	test.sql
FileSize	integer	文件大小，单位为字节。	2968269
FileSource	string	文件上传的使用目的，取值与说明如下： datacorrect：数据变更工单 order_info_attachment：工单附件 big-file：批量数据导入 sqlreview：SQL 审核	datacorrect
UploadType	string	上传附件任务类型，取值： URL OSS	URL
UploadURL	string	上传附件 URL 链接。说明当 UploadType 参数为 URL 时显示。	http://xxxx/test.sql
UploadOSSParam	object	上传附件 OSS 信息。说明当 UploadType 参数为 OSS 时显示。
Endpoint	string	OSS 的连接地址。	http://oss-cn-hangzhou.aliyuncs.com
BucketName	string	OSS Bucket 唯一标识。	test_bucket
ObjectName	string	OSS 对象名称。	test.sql
UploadedSize	integer	已上传的大小，单位为字节。	2968269
JobStatus	string	上传附件任务状态，取值和说明如下： INIT：初始化状态 PENDING：等待任务抓取 BE_SCHEDULED：待调度 FAIL：执行失败 SUCCESS：执行成功 RUNNING：正在执行	SUCCESS
JobStatusDesc	string	任务状态描述。	success
AttachmentKey	string	上传附件成功后返回的附件 Key，可在创建工单时使用。	upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql

示例

正常返回示例

JSON格式

{
  "RequestId": "BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "UploadFileJobDetail": {
    "JobKey": "65254a4c1614235217749100e",
    "FileName": "test.sql",
    "FileSize": 2968269,
    "FileSource": "datacorrect",
    "UploadType": "URL",
    "UploadURL": "http://xxxx/test.sql",
    "UploadOSSParam": {
      "Endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
      "BucketName": "test_bucket",
      "ObjectName": "test.sql"
    },
    "UploadedSize": 2968269,
    "JobStatus": "SUCCESS",
    "JobStatusDesc": "success",
    "AttachmentKey": "upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。