diff --git a/README-CN.md b/README-CN.md index 09b1f0a098..7840194ecc 100644 --- a/README-CN.md +++ b/README-CN.md @@ -4,19 +4,35 @@

-

Alibaba Cloud SDK for Java

+

Alibaba Cloud SDK for Java (V1.0)

Latest Stable Version -

-欢迎使用 Alibaba Cloud SDK for Java 。Alibaba Cloud SDK for Java 让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。 -这里向您介绍如何获取 Alibaba Cloud SDK for Java 并开始调用。 -如果您在使用 Alibaba Cloud SDK for Java 的过程中遇到任何问题，欢迎在当前 GitHub [提交 Issues](https://github.com/aliyun/aliyun-openapi-java-sdk/issues/new)。 +> ⚠️ **重要声明**：阿里云 V1.0 Java SDK 已进入终止支持状态（2025年3月1日），不再建议使用。新用户请直接使用 [V2.0 Java SDK](https://github.com/aliyun/alibabacloud-java-sdk)；已经集成 V1.0 Java SDK 的用户也建议迁移至 [V2.0 Java SDK](https://github.com/aliyun/alibabacloud-java-sdk)。V2.0 Java SDK 使用方式请参见[帮助中心文档](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk)以及[阿里云 OpenAPI 开发者门户](https://next.api.aliyun.com/)。 + +欢迎使用 Alibaba Cloud SDK for Java (V1.0)。Alibaba Cloud SDK for Java 让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。 +这里向您介绍如何获取 Alibaba Cloud SDK for Java (V1.0) 并开始调用。 +如果您在使用 Alibaba Cloud SDK for Java (V1.0) 的过程中遇到任何问题，欢迎在当前 GitHub [提交 Issues](https://github.com/aliyun/aliyun-openapi-java-sdk/issues/new)。 + +## ⚠️ 迁移声明 + +**阿里云 V1.0 Java SDK 已弃用，2025年3月1日后将不再接收更新。** + +### 为什么要迁移到 V2.0？ +- **更好的性能**：改进的架构和优化的性能 +- **增强的安全性**：现代化的安全实践和凭证管理 +- **持续维护**：持续的更新和错误修复 +- **更丰富的功能**：新功能和改进的API设计 + +### 迁移资源 +- **V2.0 SDK 仓库**：[https://github.com/aliyun/alibabacloud-java-sdk](https://github.com/aliyun/alibabacloud-java-sdk) +- **V2.0 文档**：[https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) +- **V1/V2 SDK 差异对比**：[https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks](https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks) ## 环境要求 1. 要使用 Alibaba Cloud SDK for Java ，您需要一个云账号以及一对`Access Key ID`和`Access Key Secret`。 请在阿里云控制台中的[AccessKey管理页面](https://usercenter.console.aliyun.com/?spm=5176.doc52740.2.3.QKZk8w#/manage/ak)上创建和查看您的Access Key，或者联系您的系统管理员。 @@ -65,7 +81,7 @@ ## 快速使用 -以下这个代码示例向您展示了调用 Alibaba Cloud SDK for Java 的3个主要步骤： +以下这个代码示例向您展示了调用 Alibaba Cloud SDK for Java (V1.0) 的3个主要步骤： 1. 创建DefaultAcsClient实例并初始化。 2. 创建API请求并设置参数。 3. 发起请求并处理应答或异常。 @@ -132,6 +148,8 @@ public class Main { * [阿里云服务 Regions & Endpoints](https://developer.aliyun.com/endpoints) * [OpenAPI 开发者门户](https://next.api.aliyun.com/) * [最新源码](https://github.com/aliyun/aliyun-openapi-java-sdk) +* [V2.0 Java SDK 仓库](https://github.com/aliyun/alibabacloud-java-sdk) +* [V2.0 Java SDK 文档](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) ## 许可证 [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) diff --git a/README-JP.md b/README-JP.md new file mode 100644 index 0000000000..fec568227c --- /dev/null +++ b/README-JP.md @@ -0,0 +1,167 @@ +[English](./README.md) | [简体中文](./README-CN.md) | 日本語 + +

+ +

+ +

Alibaba Cloud SDK for Java (V1.0)

+ +

+Latest Stable Version + + + +

+ +> ⚠️ **重要なお知らせ**：Alibaba Cloud V1.0 Java SDKはサポート終了（2025年3月1日）となり、使用は推奨されません。新規ユーザーは[V2.0 Java SDK](https://github.com/aliyun/alibabacloud-java-sdk)を直接ご利用ください。既にV1.0 Java SDKをご利用いただいているユーザーも、[V2.0 Java SDK](https://github.com/aliyun/alibabacloud-java-sdk)への移行をお勧めします。V2.0 Java SDKの使用方法については、[ヘルプセンターのドキュメント](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk)および[Alibaba Cloud OpenAPI Developer Portal](https://next.api.aliyun.com/)を参照してください。 + +Alibaba Cloud SDK for Java (V1.0)を使用すると、Elastic Compute Service (ECS)、Server Load Balancer (SLB)、CloudMonitorなどのAlibaba Cloudサービスにアクセスできます。API関連のタスク（署名やリクエストの構築など）を処理する必要なく、Alibaba Cloudサービスにアクセスできます。 + +このドキュメントでは、Alibaba Cloud SDK for Java (V1.0)の取得方法と呼び出し方法を紹介します。 + +Alibaba Cloud SDK for Java (V1.0)の使用中に問題が発生した場合は、GitHubで[Issueを提出](https://github.com/aliyun/aliyun-openapi-java-sdk/issues/new)してください。 + +## ⚠️ 移行に関する注意事項 + +**Alibaba Cloud V1.0 Java SDKは非推奨となり、2025年3月1日以降は更新されません。** + +### なぜV2.0に移行する必要があるのか？ +- **より良いパフォーマンス**：改善されたアーキテクチャと最適化されたパフォーマンス +- **強化されたセキュリティ**：現代的なセキュリティプラクティスと認証情報管理 +- **継続的なメンテナンス**：継続的な更新とバグ修正 +- **より豊富な機能**：新機能と改善されたAPI設計 + +### 移行リソース +- **V2.0 SDKリポジトリ**：[https://github.com/aliyun/alibabacloud-java-sdk](https://github.com/aliyun/alibabacloud-java-sdk) +- **V2.0ドキュメント**：[https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) +- **V1/V2 SDKの違い**：[https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks](https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks) + +## 必要条件 + +- Alibaba Cloud SDK for Javaを使用するには、Alibaba Cloudアカウントと`AccessKey ID`および`AccessKey Secret`が必要です。[RAMコンソール](https://ram.console.aliyun.com "RAM console")でAccessKeyを作成・表示するか、システム管理者に連絡してください。 + +- Alibaba Cloud SDK for Javaを使用して製品のAPIにアクセスするには、必要に応じて[Alibaba Cloudコンソール](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w)で製品を有効化する必要があります。 + +- Alibaba Cloud Java SDKにはJDK 1.6以降が必要です。 + +## インストール + +Apache Mavenを使用してJavaプロジェクトを管理する場合、プロジェクトのpom.xmlファイルに対応する依存関係を追加するだけで済みます。各クラウド製品のMaven依存関係は[Alibaba Cloud開発者リソース](https://help.aliyun.com/learn/developer.html)でダウンロードできます。 + +使用する製品開発キットに関係なく、`aliyun-java-sdk-core`ライブラリをインストールする必要があります。たとえば、ECS SDKを呼び出すには、`aliyun-java-sdk-core`ライブラリと`aliyun-java-sdk-ecs`ライブラリをインストールする必要があります。 + +Ecs SDKの使用例として、`pom.xml`ファイルで以下の2つの依存関係を宣言するだけで済みます。 + +```xml + + com.aliyun + aliyun-java-sdk-core + [4.4.9,5.0.0) + + + com.aliyun + aliyun-java-sdk-ecs + [4.16.0,5.0.0) + +``` + +mavenが中央リポジトリからjarパッケージをダウンロードしない場合は、これらの依存関係をpom.xmlファイルに追加する必要があり、そうしないとNoClassDefFoundError例外が報告されます。 +```xml + + com.google.code.gson + gson + 2.8.5 + + + io.opentracing + opentracing-api + 0.33.0 + + + io.opentracing + opentracing-util + 0.33.0 + +``` + +## トラブルシューティング +[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk)は、OpenAPI診断サービスを提供し、`RequestID`または`エラーメッセージ`を通じて、開発者が迅速に問題を特定し、解決策を提供します。 + +## クイックスタート + +以下のコード例は、Alibaba Cloud SDK for Java (V1.0)を使用する3つの主要ステップを示しています： + +1. `DefaultAcsClient`インスタンスを作成して初期化する。 + +2. APIリクエストを作成し、パラメータを設定する。 + +3. リクエストを開始し、応答または例外を処理する。 + +```java +package com.testprogram; +import com.aliyuncs.profile.DefaultProfile; +import com.aliyuncs.DefaultAcsClient; +import com.aliyuncs.IAcsClient; +import com.aliyuncs.exceptions.ClientException; +import com.aliyuncs.exceptions.ServerException; +import com.aliyuncs.ecs.model.v20140526.*; +public class Main { + public static void main(String[] args) { + // DefaultAcsClientインスタンスを作成して初期化 + DefaultProfile profile = DefaultProfile.getProfile( + "", // リージョンID + "", // RAMアカウントのAccessKey ID + ""); // RAMアカウントのAccessKey Secret + IAcsClient client = new DefaultAcsClient(profile); + // APIリクエストを作成し、パラメータを設定 + DescribeInstancesRequest request = new DescribeInstancesRequest(); + request.setPageSize(10); + // リクエストを開始し、応答または例外を処理 + DescribeInstancesResponse response; + try { + response = client.getAcsResponse(request); + for (DescribeInstancesResponse.Instance instance:response.getInstances()) { + System.out.println(instance.getPublicIpAddress()); + } + } catch (ServerException e) { + e.printStackTrace(); + } catch (ClientException e) { + e.printStackTrace(); + } + } +} +``` + +## ドキュメント +* [Requirements](./docs/0-Requirements-EN.md) +* [Installation](./docs/1-Installation-EN.md) +* [Client & Credentials](./docs/2-Client-EN.md) +* [Connection Pool](./docs/3-Pool-EN.md) +* [Timeout](./docs/4-Timeout-EN.md) +* [HTTPS Configurations](./docs/5-HTTPS-EN.md) +* [Proxy Configurations](./docs/6-Proxy-EN.md) +* [Debug](./docs/7-Debug-EN.md) +* [Log](./docs/8-Log-EN.md) +* [Exception](./docs/9-Exception-EN.md) +* [Endpoint](./docs/10-Endpoint-EN.md) + +## 問題 +[Issueを開く](https://github.com/aliyun/aliyun-openapi-java-sdk/issues/new)、ガイドラインに準拠していない問題は直ちに閉じられる場合があります。 + +## 変更履歴 +各リリースの詳細な変更は[リリースノート](./aliyun-java-sdk-core/ChangeLog.txt)に記録されています。 + +## 貢献 +プルリクエストを作成する前に、[貢献ガイド](CONTRIBUTING.md)を必ずお読みください。 + +## 参考文献 +* [Alibaba Cloud Regions & Endpoints](https://developer.aliyun.com/endpoints) +* [Alibaba Cloud OpenAPI Developer Portal](https://next.api.aliyun.com/) +* [最新リリース](https://github.com/aliyun/aliyun-openapi-java-sdk) +* [V2.0 Java SDKリポジトリ](https://github.com/aliyun/alibabacloud-java-sdk) +* [V2.0 Java SDKドキュメント](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) + +## ライセンス +[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) + +Copyright (c) 2009-present, Alibaba Cloud All rights reserved. \ No newline at end of file diff --git a/README.md b/README.md index 7d08147e4e..eb03ae9abc 100755 --- a/README.md +++ b/README.md @@ -4,21 +4,39 @@ English | [简体中文](./README-CN.md)

-

Alibaba Cloud SDK for Java

+

Alibaba Cloud SDK for Java (V1.0)

Latest Stable Version -

-The Alibaba Cloud SDK for Java allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests. +> ⚠️ **Important Notice**: Alibaba Cloud V1.0 Java SDK has entered End-of-Support (March 1, 2025) and is no longer recommended for use. New users should directly use the [V2.0 Java SDK](https://github.com/aliyun/alibabacloud-java-sdk); users who have already integrated the V1.0 Java SDK are also advised to migrate to the [V2.0 Java SDK](https://github.com/aliyun/alibabacloud-java-sdk). +> +> V2.0 Java SDK usage please refer to [Help Center Documentation](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) and [Alibaba Cloud OpenAPI Developer Portal](https://next.api.aliyun.com/). -This document introduces how to obtain and call Alibaba Cloud SDK for Java. +The Alibaba Cloud SDK for Java (V1.0) allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests. -If you have any problem while using Alibaba Cloud SDK for Java, please [submit an issue](https://github.com/aliyun/aliyun-openapi-java-sdk/issues/new). +This document introduces how to obtain and call Alibaba Cloud SDK for Java (V1.0). + +If you have any problem while using Alibaba Cloud SDK for Java (V1.0), please [submit an issue](https://github.com/aliyun/aliyun-openapi-java-sdk/issues/new). + +## ⚠️ Migration Notice + +**Alibaba Cloud V1.0 Java SDK is deprecated and will no longer receive updates after March 1, 2025.** + +### Why migrate to V2.0? +- **Better Performance**: Improved architecture and optimized performance +- **Enhanced Security**: Modern security practices and credential management +- **Active Maintenance**: Ongoing updates and bug fixes +- **Richer Features**: New capabilities and improved API design + +### Migration Resources +- **V2.0 SDK Repository**: [https://github.com/aliyun/alibabacloud-java-sdk](https://github.com/aliyun/alibabacloud-java-sdk) +- **V2.0 Documentation**: [https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) +- **V1/V2 SDK Differences**: [https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks](https://help.aliyun.com/zh/sdk/product-overview/differences-between-v1-and-v2-sdks) ## Requirements @@ -73,7 +91,7 @@ If maven is not downloading jar packages from a central repository, you need to ## Quick Examples -The following code example shows the three main steps to use Alibaba Cloud SDK for Java : +The following code example shows the three main steps to use Alibaba Cloud SDK for Java (V1.0): 1. Create and initialize a `DefaultAcsClient` instance. @@ -142,8 +160,10 @@ Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making ## References * [Alibaba Cloud Regions & Endpoints](https://developer.aliyun.com/endpoints) -* [Alibab Cloud OpenAPI Portal](https://next.api.aliyun.com/) +* [Alibaba Cloud OpenAPI Portal](https://next.api.aliyun.com/) * [Latest Release](https://github.com/aliyun/aliyun-openapi-java-sdk) +* [V2.0 Java SDK Repository](https://github.com/aliyun/alibabacloud-java-sdk) +* [V2.0 Java SDK Documentation](https://help.aliyun.com/zh/sdk/developer-reference/v2-java-sdk) ## License [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)