From d0b264c3f50b6db80e09c16f0d667d6dd2e241b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=81=E7=88=BD?= Date: Wed, 11 Feb 2026 17:44:21 +0800 Subject: [PATCH] Update README --- README.md | 150 +++++++++++++++++++++++++++++++-------------------- README_zh.md | 47 ++++++++++++++-- 2 files changed, 134 insertions(+), 63 deletions(-) mode change 100755 => 100644 README.md diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 14b67ba290..3a33fff901 --- a/README.md +++ b/README.md @@ -1,79 +1,102 @@ -# Alibaba Cloud Python Software Development Kit +# Alibaba Cloud Python Software Development Kit (V1.0 - Deprecated) [![PyPI version](https://badge.fury.io/py/aliyun-python-sdk-core.svg)](https://badge.fury.io/py/aliyun-python-sdk-core) [![Python test](https://github.com/aliyun/aliyun-openapi-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/aliyun/aliyun-openapi-python-sdk/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/aliyun/aliyun-openapi-python-sdk/graph/badge.svg?token=qmWxah6dPs)](https://codecov.io/gh/aliyun/aliyun-openapi-python-sdk) [![python](https://img.shields.io/pypi/pyversions/aliyun-python-sdk-core.svg)](https://img.shields.io/pypi/pyversions/aliyun-python-sdk-core.svg) -[中文文档](./README_zh.md) +[English](./README.md) | [中文文档](./README_zh.md) -The Alibaba Cloud V1.0 SDK will soon enter the Basic Security Maintenance phase and is no longer recommended for use. It is suggested to use the V2.0 SDK instead. +⚠️ **重要通知**: 阿里云 Python SDK V1.0 已进入基础安全维护阶段（预计2025年3月1日终止支持），不再推荐使用。**强烈建议**使用 [V2.0 SDK](https://github.com/aliyun/alibabacloud-python-sdk)。 -## Troubleshoot +## 🚨 重要声明 -[Troubleshoot](https://api.alibabacloud.com/troubleshoot?source=github_sdk) Provide OpenAPI diagnosis service to help developers locate quickly and provide solutions for developers through `RequestID` or `error message`. +**V1.0 SDK状态**: +- 当前处于基础安全维护阶段 +- 不再添加新功能 +- 仅修复严重安全问题 +- 预计2025年3月1日完全终止支持 -## Online Demo +**迁移建议**: +- 新项目请直接使用 [V2.0 SDK](https://github.com/aliyun/alibabacloud-python-sdk) +- 现有V1.0项目建议尽快迁移至V2.0 +- V2.0提供更好的性能、更简洁的API和更完善的文档 -**[API Developer Portal](https://api.alibabacloud.com)** provides the ability to call the cloud product OpenAPI online, and dynamically generate SDK Example code and quick retrieval interface, which can significantly reduce the difficulty of using the cloud API. **It is highly recommended**. +## 🔗 V2.0 SDK 资源 - - - +**GitHub仓库**: [https://github.com/aliyun/alibabacloud-python-sdk](https://github.com/aliyun/alibabacloud-python-sdk) -## Important Updates +**官方文档**: [https://help.aliyun.com/zh/sdk/developer-reference/v2-python-integrated-sdk](https://help.aliyun.com/zh/sdk/developer-reference/v2-python-integrated-sdk) -- Starting from version 2.16.0, the Alibaba Cloud Python SDK core library `aliyun-python-sdk-core` only supports Python 3.7 and above. +**开发者门户**: [https://api.aliyun.com](https://api.aliyun.com) -## Documentation +## 🛠 V1.0 SDK 继续使用说明 -- [Requirements](docs/0-Requirement-EN.md) -- [Installation](./docs/1-Installation-EN.md) -- [Client & Credentials](./docs/2-Client-EN.md) -- [Timeout](./docs/3-Timeout-EN.md) -- [Proxy Configurations](./docs/4-Proxy-EN.md) -- [Log](./docs/5-Log-EN.md) -- [Endpoint](./docs/6-Endpoint-EN.md) -- [Https](./docs/7-Https-EN.md) -- [Debug](./docs/8-Debug-EN.md) -- [Exception](./docs/9-Exception-EN.md) +如果您仍需要使用V1.0 SDK，请继续阅读以下内容： -## Prerequisites +## 🆘 故障诊断 -- To use Alibaba Cloud Python SDK, you must have an Alibaba Cloud account as well as an AccessKey. +[Troubleshoot](https://api.aliyun.com/troubleshoot?source=github_sdk) 提供OpenAPI使用诊断服务，通过 `RequestID` 或 `报错信息` 帮助开发者快速定位问题并提供解决方案。 - The AccessKey is required when initializing `AcsClient`. You can create an AccessKey in the Alibaba Cloud console. For more information, see [Create an AccessKey](https://usercenter.console.aliyun.com/?spm=5176.doc52740.2.3.QKZk8w#/manage/ak). +## 🌐 在线示例 - > **Note:** To increase the security of your account, we recommend that you use the AccessKey of the RAM user to access Alibaba Cloud services. +**[开发者门户](https://api.aliyun.com)** 提供在线调用云产品OpenAPI、动态生成SDK示例代码和快速检索接口等功能，能显著降低使用云API的难度。**强烈推荐使用**。 -- To use Alibaba Cloud Python SDK to access the APIs of a product, you must first activate the product on the [Alibaba Cloud console](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w) if required. +## ⚠️ 重要更新 -- Alibaba Cloud Python SDK requires Python 3.7.x and above. +- 从版本2.16.0开始，阿里云Python SDK核心库 `aliyun-python-sdk-core` 仅支持Python 3.7及以上版本 +- V1.0 SDK将不再接收新功能更新 +- 建议尽快迁移到V2.0 SDK以获得更好的支持和功能 -## Install Python SDK +## 📚 V1.0 文档 -Alibaba Cloud Python SDK supports Python 3.7.x and above. Run ``python --version`` to check your version of Python. +- [环境要求](docs/0-Requirement-EN.md) +- [安装](./docs/1-Installation-EN.md) +- [客户端与凭证](./docs/2-Client-EN.md) +- [超时机制](./docs/3-Timeout-EN.md) +- [代理配置](./docs/4-Proxy-EN.md) +- [日志](./docs/5-Log-EN.md) +- [域名](./docs/6-Endpoint-EN.md) +- [Https配置](./docs/7-Https-EN.md) +- [调试](./docs/8-Debug-EN.md) +- [异常处理](./docs/9-Exception-EN.md) -You can install the Alibaba Cloud Python SDK using the following two methods. Regardless of which method and cloud service are used, the core library `aliyun-python-sdk-core` must be installed. +## 📋 前提条件 -- **Install with pip** +- 使用阿里云Python SDK需要拥有阿里云账号以及AccessKey - Python SDK uses a common package management tool named `pip`. If pip is not installed, see the [pip user guide](https://pip.pypa.io/en/stable/installing/?spm=5176.doc53090.2.7.zHDiNV "pip User Guide") to install pip. + 初始化 `AcsClient` 时需要AccessKey。您可以在阿里云控制台创建AccessKey。更多信息请参见[创建AccessKey](https://usercenter.console.aliyun.com/?spm=5176.doc52740.2.3.QKZk8w#/manage/ak)。 - Run the following command to install the individual libraries of Alibaba Cloud services: + > **注意：** 为了提高账号安全性，建议使用RAM用户的AccessKey访问阿里云服务。 + +- 使用阿里云Python SDK访问产品API前，如需要请先在[阿里云控制台](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w)开通该产品。 + +- 阿里云Python SDK要求Python 3.7.x及以上版本。 + +## 📦 安装Python SDK + +阿里云Python SDK支持Python 3.7.x及以上版本。运行 ``python --version`` 检查您的Python版本。 + +您可以使用以下两种方法安装阿里云Python SDK。无论使用哪种方法和云服务，都必须安装核心库 `aliyun-python-sdk-core`。 + +- **使用pip安装（推荐）** + + Python SDK使用名为 `pip` 的通用包管理工具。如果未安装pip，请参见[pip用户指南](https://pip.pypa.io/en/stable/installing/?spm=5176.doc53090.2.7.zHDiNV "pip User Guide")安装pip。 + + 运行以下命令安装阿里云服务的各个库： ```bash - # Install the core library + # 安装核心库 pip install aliyun-python-sdk-core - # Install the ECS management library + # 安装ECS管理库 pip install aliyun-python-sdk-ecs - # Install the RDS management library + # 安装RDS管理库 pip install aliyun-python-sdk-rds ``` -## Use Python SDK +## 🚀 使用Python SDK -1. Import the required modules as follows: +1. 导入所需模块： ```python from aliyunsdkcore.client import AcsClient @@ -82,7 +105,7 @@ You can install the Alibaba Cloud Python SDK using the following two methods. Re from aliyunsdkecs.request.v20140526 import DescribeInstancesRequest from aliyunsdkecs.request.v20140526 import StopInstanceRequest ``` -2. Initialize the `AcsClient` instance: +2. 初始化 `AcsClient` 实例： ```python client = AcsClient( @@ -92,28 +115,28 @@ You can install the Alibaba Cloud Python SDK using the following two methods. Re ) ``` - where: + 其中： - - `access-key-id` is the Accesskey ID for your account. - - `access-key-secret` is the AccessKey secret for your account. - - `region-id` is the ID of the region where the service is called. For a list of region IDs, see [Regions and zones](https://www.alibabacloud.com/help/doc-detail/40654.html). + - `access-key-id` 是您账号的AccessKey ID。 + - `access-key-secret` 是您账号的AccessKey Secret。 + - `region-id` 是调用服务的区域ID。区域ID列表请参见[地域和可用区](https://www.alibabacloud.com/help/doc-detail/40654.html)。 - > **Note:** The sequence of these parameters cannot be changed. + > **注意：** 这些参数的顺序不能更改。 -3. Initialize a request and print response. +3. 初始化请求并打印响应： ```python - # Initialize a request and set parameters + # 初始化请求并设置参数 request = DescribeInstancesRequest.DescribeInstancesRequest() request.set_PageSize(10) - # Print response + # 打印响应 response = client.do_action_with_exception(request) print response ``` -## Code example +## 💻 代码示例 -The following example shows how to query a list of ECS instances in a specific region using [DescribeInstances](~~25506~~). Substitute the values for `your-access-key-id`, `your-access-key-secret`, and `your-region-id`. +以下示例展示了如何使用[DescribeInstances](~~25506~~)查询特定区域的ECS实例列表。请替换 `your-access-key-id`、`your-access-key-secret` 和 `your-region-id` 的值。 ```python # -*- coding: utf8 -*- @@ -124,28 +147,27 @@ from aliyunsdkcore.acs_exception.exceptions import ServerException from aliyunsdkecs.request.v20140526 import DescribeInstancesRequest from aliyunsdkecs.request.v20140526 import StopInstanceRequest -# Initialize AcsClient instance +# 初始化AcsClient实例 client = AcsClient( "", "", "" ) -# Initialize a request and set parameters +# 初始化请求并设置参数 request = DescribeInstancesRequest.DescribeInstancesRequest() request.set_PageSize(10) -# Print response +# 打印响应 response = client.do_action_with_exception(request) print response ``` -## HTTP DEBUG +## 🐛 HTTP调试 -To use the function `HTTP DEBUG`, you must set `DEBUG` in your environment variable, the corresponding value -may be `sdk` or `SDK`. +要使用 `HTTP DEBUG` 功能，您必须在环境变量中设置 `DEBUG`，对应的值可以是 `sdk` 或 `SDK`。 -The following example shows what the `HTTP DEBUG` do, which will help you debug your codes. +以下示例展示了 `HTTP DEBUG` 的作用，这将帮助您调试代码： ```plaintext > GET /databases?RegionId=cn-hangzhou HTTP/1.1 @@ -175,3 +197,15 @@ The following example shows what the `HTTP DEBUG` do, which will help you debug < x-acs-request-id : 670F3D09-F8E7-4144-83C3-B56C35DA35ED < Server : Jetty(7.2.2.v20101205) ``` + +## 🤝 贡献 + +请确保在提交pull request之前阅读[贡献指南](CONTRIBUTING.md)。 + +## 📄 许可证 + +[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) + +--- + +**推荐使用 [V2.0 SDK](https://github.com/aliyun/alibabacloud-python-sdk) 获得更好的开发体验！** 🚀 \ No newline at end of file diff --git a/README_zh.md b/README_zh.md index 11478fb475..0942f21b92 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,11 +1,36 @@ -# 阿里云开发者 Python 工具套件 +# 阿里云开发者 Python 工具套件 (V1.0 - 已废弃) [![PyPI version](https://badge.fury.io/py/aliyun-python-sdk-core.svg)](https://badge.fury.io/py/aliyun-python-sdk-core) [![Python test](https://github.com/aliyun/aliyun-openapi-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/aliyun/aliyun-openapi-python-sdk/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/aliyun/aliyun-openapi-python-sdk/graph/badge.svg?token=qmWxah6dPs)](https://codecov.io/gh/aliyun/aliyun-openapi-python-sdk) [![python](https://img.shields.io/pypi/pyversions/aliyun-python-sdk-core.svg)](https://img.shields.io/pypi/pyversions/aliyun-python-sdk-core.svg) -阿里云 V1.0 SDK 即将进入基础安全维护阶段，不再建议使用，建议使用 V2.0 SDK。 +⚠️ **重要通知**: 阿里云 Python SDK V1.0 已进入基础安全维护阶段（预计2025年3月1日终止支持），不再推荐使用，**强烈建议**使用 [V2.0 SDK](https://github.com/aliyun/alibabacloud-python-sdk)。 + +## 🚨 重要声明 + +**V1.0 SDK状态**: +- 当前处于基础安全维护阶段 +- 不再添加新功能 +- 仅修复严重安全问题 +- 预计2025年3月1日完全终止支持 + +**迁移建议**: +- 新项目请直接使用 [V2.0 SDK](https://github.com/aliyun/alibabacloud-python-sdk) +- 现有V1.0项目建议尽快迁移至V2.0 +- V2.0提供更好的性能、更简洁的API和更完善的文档 + +## 🔗 V2.0 SDK 资源 + +**GitHub仓库**: [https://github.com/aliyun/alibabacloud-python-sdk](https://github.com/aliyun/alibabacloud-python-sdk) + +**官方文档**: [https://help.aliyun.com/zh/sdk/developer-reference/v2-python-integrated-sdk](https://help.aliyun.com/zh/sdk/developer-reference/v2-python-integrated-sdk) + +**开发者门户**: [https://api.aliyun.com](https://api.aliyun.com) + +## 🛠 V1.0 SDK 继续使用说明 + +如果您仍需要使用V1.0 SDK，请继续阅读以下内容： ## 使用诊断 @@ -21,7 +46,9 @@ ## 重要的更新 -- 阿里云 Python SDK 核心库 `aliyun-python-sdk-core` 版本从 2.16.0 开始，仅支持 Python 3.7 及以上的环境。 +- 阿里云 Python SDK 核心库 `aliyun-python-sdk-core` 版本从 2.16.0 开始，仅支持 Python 3.7 及以上的环境 +- V1.0 SDK将不再接收新功能更新 +- 建议尽快迁移到V2.0 SDK以获得更好的支持和功能 ## 文档 @@ -36,7 +63,6 @@ - [调试](./docs/8-Debug-CN.md) - [异常](./docs/9-Exception-CN.md) - ## 环境准备 1. 要使用阿里云 Python SDK ，您需要一个云账号以及一对`Access Key ID`和`Access Key Secret`。 请在阿里云控制台中的 [AccessKey管理页面](https://usercenter.console.aliyun.com/?spm=5176.doc52740.2.3.QKZk8w#/manage/ak) 上创建和查看您的 Access Key，或者联系您的系统管理员 @@ -59,7 +85,6 @@ pip install aliyun-python-sdk-ecs # 安装管理 ECS SDK 2. 创建 API 请求并设置参数 3. 发起请求并处理异常 - ```python # -*- coding: utf8 -*- from aliyunsdkcore.client import AcsClient @@ -116,3 +141,15 @@ print response < x-acs-request-id : 670F3D09-F8E7-4144-83C3-B56C35DA35ED < Server : Jetty(7.2.2.v20101205) ``` + +## 贡献 + +请确保在提交pull request之前阅读[贡献指南](CONTRIBUTING.md)。 + +## 许可证 + +[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0) + +--- + +**推荐使用 [V2.0 SDK](https://github.com/aliyun/alibabacloud-python-sdk) 获得更好的开发体验！** 🚀 \ No newline at end of file