ファイルのアップロード
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
認証APIを使用してaccessTokenを取得した後、対応するヘッダーに入力する必要があります。
説明: このAPIは、スケジューリングAPIでタスクまたはロボットをスタートアップする場面で使用します。フローにファイルタイプの入力パラメータがある場合は、先にこのAPIを呼び出してファイルのアップロードを完了してください。このAPIからファイルキーが返されるので、そのファイルキーを入力パラメータとして渡します。Dr.Roboのスケジューリングプログラムは、ファイルキーに基づいて、ロボットが認識してダウンロードできるファイルURLを生成します。
アップロードの制限
- 1回のアップロードは10Mを超えることができません。
- 現在サポートされているファイルタイプはtxt,csv,xslxです。
- ファイル名の長さは100以内を推奨します。超過すると制限されます。
- ファイルの有効期間は7日間です。7日を過ぎるとファイルにアクセスできなくなります。この制限により、7日を超えたjobを再試行した場合、ロボットによるロボットの実行が失敗する可能性があります。
- 企業ごとのファイルアップロード容量の上限は100Mです。つまり、1つの企業が7日間でアップロードする累計容量は100Mを超えることができません。
- ファイルが無効になると、15分以内にその分のアップロード容量が再利用可能になります。
リクエスト
| 基本 | 説明 | |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/file/upload | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | 説明 | |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken} 変数は、認証APIから返されたaccess Tokenに置き換える必要があります |
| Content-Type | multipart/form-data |
リクエストパラメータ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| file | file | はい | 対象ファイルのバイナリファイルストリームです。具体的な使用方法は、上記のサンプルコードを参照してください |
レスポンス
レスポンス本文
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を表します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| msg | string | はい | ステータスコードの説明です |
| data | object | はい | レスポンスデータです |
| ∟fileKey | string | はい | ファイルのfileKeyです。ロボットのスタートアップとタスクのスタートアップ のファイルタイプの入力パラメータに使用します |
レスポンス本文の例
成功レスポンス
{
"data": {
"fileKey": "aedbdaad-0c9c-4c05-9082-be42f0ba03a2"
},
"code": 200,
"success": true
}
失敗レスポンス
サポートされていないファイルタイプ
{
"code": 80204003,
"success": false,
"requestId": "eb9bf57c1e54ea2668e06ae1",
"serverInstName": "xybot-dispatch",
"msg": "原因:仅支持:txt,csv,xlsx 文件类型,文件上传失败"
}
1回のアップロードが上限を超えています
{
"code": 80200010,
"success": false,
"requestId": "7be91cbdd8451eabf187d66c",
"serverInstName": "xybot-dispatch",
"msg": "文件大小超出限制,阈值:3145728"
}
ファイル名が長すぎます(100行の上限を超えています)
{
"code": 80204003,
"success": false,
"requestId": "7129aee8c0feba6860bf4837",
"serverInstName": "xybot-dispatch",
"msg": "原因:文件名超长,文件上传失败"
}
ファイルの累計使用量が上限を超えています(累計100M)
{
"code": 80204003,
"success": false,
"requestId": "1638a2c5a3910a564c8a6d91",
"serverInstName": "xybot-dispatch",
"msg": "文件存储使用量超过限制,1048576"
}
| エラーコード | 説明 | 調査のヒント |
|---|---|---|
| 200 | 正常 | 呼び出しは正常です |
| 500 | サーバー側のエラー | サーバー側のエラーについては、テクニカルサポートにお問い合わせください |
| 80204003 | ファイルのアップロード失敗 | メッセージの指示に従って対処してください。通常は、上記の制限条件に該当したことによる失敗です |
| 80200010 | 1回のファイルアップロードのサイズが大きすぎます | ファイルサイズが上限を超えています。しきい値:3145728 |
サンプルコード
/path/to/fileをファイルのパスに置き換えてください。
Python
import requests
url = "https://api.example.com/oapi/dispatch/v2/file/upload"
payload={}
files=[
('file',('file',open('/path/to/file','rb'),'application/octet-stream'))
]
headers = {
'Authorization': 'Bearer {accessToken}'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
Curl
curl --location --request POST 'https://api.example.com/oapi/dispatch/v2/file/upload' \
--header 'Authorization: Bearer {accessToken}' \
--form 'file=@"/path/to/file"'
エラーが発生した場合は、ステータスコードの説明に移動してください