调用CreateUploadOSSFileJob接口,创建上传OSS附件任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| FileSource | String | 是 | datacorrect |
上传附件的使用目的,取值和说明如下:
|
| FileName | String | 是 | test.sql |
文件名。 说明 需要以txt、sql结尾,例如test.txt。
|
| UploadTarget | Object | 是 |
OSS信息。 |
|
| Endpoint | String | 是 | http://oss-cn-hangzhou.aliyuncs.com |
OSS的连接地址。 |
| BucketName | String | 是 | test_bucket |
OSS Bucket唯一标识。 |
| ObjectName | String | 是 | test.sql |
OSS对象名称。 |
| Tid | Long | 否 | -1 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
| RegionId | String | 否 | cn-hangzhou |
选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明。 说明 请根据应用所在地就近选择。
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 4E1D2B4D-3E53-4ABC-999D-1D2520B3471A |
请求ID。 |
| Success | Boolean | true |
请求是否成功。 |
| ErrorMessage | String | UnknownError |
错误信息。 |
| ErrorCode | String | UnknownError |
错误码。 |
| JobKey | String | 65254a4c1614235217749100e |
上传附件任务Key,可查询附件上传进展与任务详情,详情请参见GetUserUploadFileJob。 |
示例
请求示例
http(s)://dms-enterprise.aliyuncs.com/?FileSource=datacorrect
&FileName=test.sql
&UploadType=OSS
&UploadTarget={"Endpoint":"http://oss-cn-hangzhou.aliyuncs.com","BucketName":"test_bucket","ObjectName":"test.sql"}
&Tid=-1
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateUploadOSSFileJobResponse>
<JobKey>7000005000007000009000000</JobKey>
<RequestId>44355324-9534-4AF4-B7AA-8EDE3C767889</RequestId>
<Success>true</Success>
</CreateUploadOSSFileJobResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"JobKey" : "7000005000007000009000000",
"RequestId" : "44355324-9534-4AF4-B7AA-8EDE3C767889",
"Success" : true
}
错误码
访问错误中心查看更多错误码。