Data Management:データエージェント OpenAPI の統合

プロセスの概要

1. 署名の取得：DescribeFileUploadSignature API を呼び出して、OSS への直接アップロードに必要な一時的な認証情報と設定を取得します。

2. ファイルのアップロード：HTTP クライアントを使用して multipart/form-data POST リクエストを構築し、署名で指定された OSS アドレスにファイルを直接アップロードします。

3. アップロードの確認：ファイルが正常にアップロードされた後、FileUploadCallback API を呼び出して DMS サービスに通知し、FileId を取得します。

4. (オプション) ファイルの削除：FileId を指定して DeleteFileUpload API を呼び出し、アップロードされたファイルを削除します。

詳細なプロセス

• DescribeFileUploadSignature を呼び出して署名を取得

  Config config = new Config()
    .setAccessKeyId("**********")
    .setAccessKeySecret("**********")
    .setEndpoint("dms.cn-hangzhou.aliyuncs.com")
    .setRegionId("cn-hangzhou");
  
  // DMS クライアントインスタンスを作成します。
  com.aliyun.dms20250414.Client client = new com.aliyun.dms20250414.Client(config);
  
  // ステップ 1：ファイルのアップロード署名情報を取得します。
  // describeFileUploadSignature メソッドを呼び出して、OSS アップロードに必要な署名と設定情報を取得します。
  DescribeFileUploadSignatureRequest request = new DescribeFileUploadSignatureRequest();
  DescribeFileUploadSignatureResponse response = client.describeFileUploadSignature(request);
  
  // response.getBody().getData() は、後続のファイルアップロードに必要な次の情報を返します。
  // ossCredential
  // ossDate
  // ossSecurityToken
  // ossSignature
  // ossSignatureVersion
  // policy
  // uploadDir
  // uploadHost

• 署名情報を使用してファイルをアップロード

  • コード例：

    import okhttp3.*;
    import java.io.File;
    import java.io.IOException;
    
    /**
      * <dependency>
      *     <groupId>com.squareup.okhttp3</groupId>
      *     <artifactId>okhttp</artifactId>
      *     <version>4.12.0</version>
      * </dependency>
      */
    public class Main {
    
        public static void main(String[] args) throws IOException {
            OkHttpClient client = new OkHttpClient();
    
            // 次の変数は、DescribeFileUploadSignature API から返される値のプレースホルダーです。
            String policy = "eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5aZXdMdlN5SFRzdURFRGprSlh4VFF3YjgvMjAyNjAxMDMvY24taGFuZ3pob3Uvb3NzL2FsaXl1bl92NF9yZXF1ZXN0In0seyJ4LW9zcy1kYXRlIjoiMjAyNjAxMDNUMDYzN**********************************";
            String signature = "623e53b1d07431d17cd60389329de2906882d8c4eb****************";
            String signatureVersion = "OSS4-HMAC-SHA256";
            String credential = "STS.NZewLvSy**********/20260103/cn-hangzhou/oss/aliyun_v4_request";
            String date = "20260103T063703Z";
            String securityToken = "CAIS4gJ1q6Ft5B2yfSjIr5nQPPbCvqZp47GeRmP1jmsfVPd4vrLJ2jz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9r6Jc9c6gjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIiaZEa91greI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+hsgbbvFuG2QagAFh1H7d9Oe4VqNEu9A77lsl40KWoyVULPdbT+3fFlpd4s/gDL2lRdm1pTK60pwHPCp8LEI9sYOuUupKxVeNuCb0xRNOK**************************************************************";
            String key = "data_agent/file_upload/16738266********/20260103T063703Z/b8zokydg5bxg1d*********/date.csv";
            String uploadHost = "https://******.oss-cn-hangzhou.aliyuncs.com";
    
            RequestBody requestBody = new MultipartBody.Builder()
                    .setType(MultipartBody.FORM)
                    .addFormDataPart("success_action_status", "200")
                    .addFormDataPart("policy", policy)
                    .addFormDataPart("x-oss-signature", signature)
                    .addFormDataPart("x-oss-signature-version", signatureVersion)
                    .addFormDataPart("x-oss-credential", credential)
                    .addFormDataPart("x-oss-date", date)
                    .addFormDataPart("key", key)
                    .addFormDataPart("x-oss-security-token", securityToken)
                    .addFormDataPart("file", "date.csv",
                            RequestBody.create(new File("/Downloads/date.csv"), MediaType.parse("text/csv")))
                    .build();
    
            Request request = new Request.Builder()
                    .url(uploadHost)
                    .post(requestBody)
                    .build();
    
            try (Response response = client.newCall(request).execute()) {
                System.out.println("Response Code: " + response.code());
                System.out.println("Response Body: " + response.body().string());
            }
        }
    }
    

  • パラメーターの説明：

    パラメーター	型	例	説明
    success_action_status	int	200	必須。
    policy	string	eyJjb25kaXRpb25zIjpbeyJ4***********************	必須。DescribeFileUploadSignature API が返します。
    x-oss-signature	string	78dc0f211df15e21e********	必須。DescribeFileUploadSignature API が返します。
    x-oss-signature-version	string	OSS4-HMAC-SHA256	必須。DescribeFileUploadSignature API が返します。
    x-oss-credential	string	STS.NZdn3cJ1UX************/20260101/cn-hangzhou/oss/aliyun_v4_request	必須。DescribeFileUploadSignature API が返します。
    x-oss-date	string	20260101T161427Z	必須。DescribeFileUploadSignature API が返します。
    x-oss-security-token	string	CAIS4gJ1q6Ft5B2yfSjIr5nRJYnXp+5075etelGD3HQjYsoUj****************************	必須。DescribeFileUploadSignature API が返します。
    key	string	data_agent/file_upload/16738266************/20260101T161427Z/80z0lplhacu4***************/date.csv	必須。ファイルの完全なアップロードパス。このパスは、DescribeFileUploadSignature 応答の UploadDir とファイル名を組み合わせたものです：${UploadDir}/${filename} UploadDir=data_agent/file_upload/16738266************/20260101T161427Z/80z0lplhacu4***************/ filename=date.csv
    file	バイナリ	@date.csv;type=text/csv	必須。ファイルのファイル名、バイナリデータ、および MediaType。 file フィールドは、multipart/form-data リクエストの最後のパートに配置する必要があります。 最大ファイルサイズは 200 MB です。 サポートされている形式とその MediaType 値： csv：text/csv xlsx：application/vnd.openxmlformats-officedocument.spreadsheetml.sheet xls：application/vnd.ms-excel

  • 実装例 (cURL)：

    curl -v \
      -F "success_action_status=200" \
      -F "policy=eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5aZG4zY0oxVVhVRnh3Mjh0dm5FOGJ3V3ovMjAyNjAxMDEvY24taGFuZ3pob3Uvb3NzL2FsaXl1bl92NF9yZXF1ZXN0In0seyJ4LW9zcy1kYXRlIjoiMjAyNjAxMDFUMTYxNDI3WiJ9LHsieC1vc3Mtc2VjdXJpdHktdG9rZW4iOiJDQUlTNGdKMXE2RnQ1QjJ5ZlNqSXI1blJKWW5YcCs1MDc1ZXRlbEdEM0hRallzb1VqYkw4bUR6MklIaE1kWGxyQ09nWXQvOHhuRzFWNmY4ZmxySi9Ub1FBWDBIZmF0WnE1WmtTOUFxbmFvWE0vdGU0OTZJRmc1RDlvL2xOdDhHZ2pxSG9lT3pjWUk3M1dKWEVNaUxwOUVKYXhiLzlhay9SUFRpTU9vR****************************************************************************" \
      -F "x-oss-signature=78dc0f211df15e21e675ad3835a0f18f*******************" \
      -F "x-oss-signature-version=OSS4-HMAC-SHA256" \
      -F "x-oss-credential=STS.NZdn3cJ1UXU**************************************/20260101/cn-hangzhou/oss/aliyun_v4_request" \
      -F "x-oss-date=20260101T161427Z" \
      -F "key=data_agent/file_upload/16738266********/20260101T161427Z/80z0lplhacu40***********/date.csv" \
      -F "x-oss-security-token=CAIS4gJ1q6Ft5B2yfSjIr5nRJYnXp+5075etelGD3HQjYsoUjbL8mDz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9o/lNt8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIiaJ1W/5/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+oQx4pPFuG2QagAFUp8U5qf8WDmpuc7ztSzLSLizgMnGPNbJGjU1dYCd2P0omHZaZyeuTj7QGpX0IW6DuKpvvHS9i/8R8M0dL2ssMsWTeK4wYE6sWXp7SbqM0mZY**************************************" \
      -F "file=@date.csv;type=text/csv" \
      "https://*******.oss-cn-hangzhou.aliyuncs.com"

• アップロード成功後の確認

  DescribeFileUploadSignatureResponseBody.DescribeFileUploadSignatureResponseBodyData data = response.getBody().getData();
  String filename = "date.csv";
  String uploadLocation = data.getUploadDir() + "/" +  filename;
  
  // ファイルが正常にアップロードされたことを DMS サービスに通知し、ファイル ID を取得します。
  FileUploadCallbackRequest callbackRequest = new FileUploadCallbackRequest();
  callbackRequest.setFilename(filename);              // ファイル名を設定します。
  callbackRequest.setUploadLocation(uploadLocation);  // アップロード場所を設定します。
  
  // コールバックリクエストを送信してファイル ID を取得します。
  FileUploadCallbackResponse callbackResponse = client.fileUploadCallback(callbackRequest);
  System.out.println("Upload successful. File ID: " + callbackResponse.getBody().getData().getFileId());

• アップロードされたファイルの削除

  // ファイル ID を使用してアップロードされたファイルを削除します。
  DeleteFileUploadRequest request = new DeleteFileUploadRequest();
  request.setFileId(callbackResponse.getBody().getData().getFileId());
  
  DeleteFileUploadResponse response = client.deleteFileUpload(request);

• 以下は、前述のすべての手順を統合した完全な Java の例です。

  import com.aliyun.dms20250414.models.*;
  import com.aliyun.teaopenapi.models.Config;
  import okhttp3.*;
  
  import java.io.File;
  import java.io.IOException;
  
  /**
   * DMS サービスを使用して OSS にファイルをアップロードする完全なプロセスを示します。
   * プロセスには以下が含まれます：
   * 1. アップロード署名情報の取得。
   * 2. OSS へのファイルのアップロード。
   * 3. 確認のためのアップロードコールバックの送信。
   */
  public class FileUploadExample {
  
      // ローカルファイルパスとアップロード設定を定義します。
      private static final String localFilePath = "/Users/******/Downloads/date.csv";  // ローカルファイルパス
      private static final String filename = "date.csv";                               // ファイル名
  
      public static void main(String[] args) throws Exception {
          // DMS クライアントのパラメーターを設定します。
          Config config = new Config()
                  .setAccessKeyId("********")
                  .setAccessKeySecret("********")
                  .setEndpoint("dms.cn-hangzhou.aliyuncs.com")
                  .setRegionId("cn-hangzhou");
  
          // DMS クライアントインスタンスを作成します。
          com.aliyun.dms20250414.Client client = new com.aliyun.dms20250414.Client(config);
  
          // ステップ 1：ファイルのアップロード署名情報を取得します。
          // describeFileUploadSignature メソッドを呼び出して、OSS アップロードに必要な署名と設定情報を取得します。
          DescribeFileUploadSignatureRequest request = new DescribeFileUploadSignatureRequest();
          DescribeFileUploadSignatureResponse response = client.describeFileUploadSignature(request);
          System.out.println(response.getBody().getData());
  
          // 応答データを解析して、必要なアップロード設定情報を取得します。
          DescribeFileUploadSignatureResponseBody.DescribeFileUploadSignatureResponseBodyData data = response.getBody().getData();
          String uploadLocation = data.getUploadDir() + "/" +  filename;                   // OSS のアップロードパス
  
          // ステップ 2：ファイルを OSS にアップロードします。
          // 取得した署名情報を使用してファイルを OSS にアップロードします。
          int code = doUploadFile(data, filename, localFilePath, uploadLocation);
          
          // アップロードが成功したら、確認のためにコールバックを送信します。
          if (code == 200) {
              // ステップ 3：アップロード成功後、確認のためにコールバックを送信します。
              // ファイルが正常にアップロードされたことを DMS サービスに通知し、ファイル ID を取得します。
              FileUploadCallbackRequest callbackRequest = new FileUploadCallbackRequest();
              callbackRequest.setFilename(filename);              // ファイル名を設定します。
              callbackRequest.setUploadLocation(uploadLocation);  // アップロードパスを設定します。
  
              // コールバックリクエストを送信してファイル ID を取得します。
              FileUploadCallbackResponse callbackResponse = client.fileUploadCallback(callbackRequest);
              
              // アップロード成功後、ファイル ID を出力します。
              System.out.println("Upload successful. File ID: " + callbackResponse.getBody().getData().getFileId());
          } else {
              System.out.println("File upload failed. Status code: " + code);
          }
      }
  
      /**
       * ファイルを OSS にアップロードします。
       * 
       * このメソッドは OkHttp クライアントを使用してファイルを OSS にアップロードします。OSS 署名情報やファイルの詳細などのパラメーターが必要です。
       * 
       * @param data describeFileUploadSignature API から取得した署名データ。
       * @param filename ファイル名。
       * @param fileLocalPath ファイルのローカルパス。
       * @param uploadLocation OSS のアップロードパス。
       * @return アップロードの HTTP ステータスコード。200 は成功を示します。
       * @throws IOException ネットワークまたはファイル操作エラーが発生した場合。
       */
      private static int doUploadFile(DescribeFileUploadSignatureResponseBody.DescribeFileUploadSignatureResponseBodyData data, String filename, String fileLocalPath, String uploadLocation) throws IOException {
          OkHttpClient client = new OkHttpClient();
  
          // OSS アップロードに必要なすべてのパラメーターを含む、マルチパートフォームリクエストボディを構築します。
          RequestBody requestBody = new MultipartBody.Builder()
                  .setType(MultipartBody.FORM)
                  .addFormDataPart("success_action_status", "200")                      // success_action_status を 200 に設定する必要があります。
                  .addFormDataPart("policy", data.getPolicy())                          // 署名ポリシー
                  .addFormDataPart("x-oss-signature", data.getOssSignature())           // OSS 署名
                  .addFormDataPart("x-oss-signature-version", data.getOssSignatureVersion()) // 署名バージョン
                  .addFormDataPart("x-oss-credential", data.getOssCredential())         // 認証情報
                  .addFormDataPart("x-oss-date", data.getOssDate())                     // 日付
                  .addFormDataPart("key", uploadLocation)                               // アップロードパス
                  .addFormDataPart("x-oss-security-token", data.getOssSecurityToken())  // セキュリティトークン
                  .addFormDataPart("file", filename,                                    // ファイルパート
                          RequestBody.create(new File(fileLocalPath), MediaType.parse("text/csv"))) // ファイルリクエストボディを作成します。ファイルの種類に応じてメディアタイプを設定します。
                  .build();
  
          // POST リクエストを構築します。
          Request request = new Request.Builder()
                  .url(data.getUploadHost())  // 返されたアップロードホストアドレスを使用します。
                  .post(requestBody)          // リクエストボディを設定します。
                  .build();
  
          // リクエストを実行し、応答を処理します。
          try (Response response = client.newCall(request).execute()) {
              System.out.println("Upload response code: " + response.code());
              System.out.println("Upload response body: " + response.body().string());
              return response.code();
          }
      }
  }

  重要

  アップロードリクエストを構築する際は、DescribeFileUploadSignature から取得したすべてのフォームフィールドを含めるようにしてください。file フィールドは、multipart/form-data リクエストの最後のパートに配置する必要があります。

  • 最大ファイルサイズ：200 MB。

  • サポートされている形式：CSV、XLSX、XLS。ファイルの種類に基づいて正しい MediaType を設定してください。